Skip to content

Commit

Permalink
fix: readme links
Browse files Browse the repository at this point in the history
  • Loading branch information
amessbee committed Jul 18, 2024
1 parent 9047c52 commit fdfe3e7
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 15 deletions.
14 changes: 0 additions & 14 deletions README-code-space.md

This file was deleted.

17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Agoric Dapp Starter: Agoric Basics

This is a basic Agoric Dapp that contains three smart contracts `postal-service`, `sell-concert-tickets`, and `swaparoo` demonstrating different scenarios which can be implemented easily using Agoric SDK. There is also a UI for `sell-concert-tickets` contract that a user can use to buy three different types of concert tickets and pay through a wallet extension in the browser.
The following instrucions provide a guide to setup an environment to try `dapp-agoric-basics` on your local machine. If you want to try it in cloud environment without any installations or downloads, you can [try it in github codespaces](README-code-space.md).
The following instrucions provide a guide to setup an environment to try `dapp-agoric-basics` on your local machine. If you want to try it in cloud environment without any installations or downloads, you can [try it in github codespaces](#instructions-to-run-dapp-agoric-basic-in-ghcs).

## Getting started

Expand Down Expand Up @@ -30,5 +30,20 @@ To perform unit tests:
To perform end to end test
-run the command `yarn test:e2e` in the root directory.

## Instructions to run `dapp-agoric-basic` in GHCS

Here are the step-by-step instructions to run/work on `dapp-agoric-basic` in github codespaces:

1. Go to repo here: [https://github.com/Agoric/dapp-agoric-basics/](https://github.com/Agoric/dapp-agoric-basics/)
2. Click on ![Green `<> Code` button](https://docs.github.com/assets/cb-13128/mw-1440/images/help/repository/code-button.webp)
3. Click on `Codespaces` tab and create a new Codespace. If you are already using Codespaces on current repo then click the "+" button on top right of the `Codespaces` tab to create a new one.
4. You should see a VSCode environment load in your browser followed by a setup. This should take a few minutes.
5. Once it's done do `yarn install` in the terminal.
6. Do `yarn start:docker` followed by `yarn docker:logs` - kill it after you see `begin`/`commit`.
7. Do `yarn start:contract`.
8. Do `yarn start:ui` - a pop-up should appear in bottom right. Click open in browser if needed.
9. DApp should be load in your browser.
10. Connect your Wallet and interact with DApp as usual.

## Contributing
See [CONTRIBUTING](./CONTRIBUTING.md) for more on contributions.

0 comments on commit fdfe3e7

Please sign in to comment.