Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Improve README documentation for demo projects #69

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 22 additions & 3 deletions brc20-market-demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,37 @@

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

### Run the demo
### Prerequisites

#### Install dependencies
Before running the demo, ensure you have the following installed:
- Node.js (version 14.0.0 or later)
- Yarn package manager

### Run the Demo

Follow these steps to get the demo up and running:

#### Install Dependencies

Navigate to the `brc20-market-demo` directory and install the necessary dependencies:

```bash
yarn
```

#### Run the app
#### Run the App

Once the dependencies are installed, start the application with the following command:

```bash
yarn start
```

This will run the app in development mode. Open [http://localhost:3000](http://localhost:3000) in your browser to
view the demo. The page will automatically reload if you make changes to the code, and you will see any build errors
or lint warnings in the console.

### Additional Information

For more details on using Create React App, refer to the [Create React App documentation](https://create-react-app.dev/docs/getting-started/).
If you encounter any issues, consider checking the documentation or community resources for troubleshooting tips.
27 changes: 23 additions & 4 deletions brc20-swap-demo/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,38 @@
## brc20-swap Demo
## BRC20-Swap Demo

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

### Run the demo
### Prerequisites

#### Install dependencies
Before running the demo, ensure you have the following installed:
- Node.js (version 14.0.0 or later)
- Yarn package manager

### Run the Demo

Follow these steps to get the demo up and running:

#### Install Dependencies

Navigate to the `brc20-swap-demo` directory and install the necessary dependencies:

```bash
yarn
```

#### Run the app
#### Run the App

Once the dependencies are installed, start the application with the following command:

```bash
yarn start
```

This will run the app in development mode. Open [http://localhost:3000](http://localhost:3000) in your browser to
view the demo. The page will automatically reload if you make changes to the code, and you will see any build errors
or lint warnings in the console.

### Additional Information

For more details on using Create React App, refer to the [Create React App documentation](https://create-react-app.dev/docs/getting-started/).
If you encounter any issues, consider checking the documentation or community resources for troubleshooting tips.
25 changes: 22 additions & 3 deletions unisat-inscribe-demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,37 @@

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

### Run the demo
### Prerequisites

#### Install dependencies
Before running the demo, ensure you have the following installed:
- Node.js (version 14.0.0 or later)
- Yarn package manager

### Run the Demo

Follow these steps to get the demo up and running:

#### Install Dependencies

Navigate to the `unisat-inscribe-demo` directory and install the necessary dependencies:

```bash
yarn
```

#### Run the app
#### Run the App

Once the dependencies are installed, start the application with the following command:

```bash
yarn start
```

This will run the app in development mode. Open [http://localhost:3000](http://localhost:3000) in your browser to
view the demo. The page will automatically reload if you make changes to the code, and you will see any build errors
or lint warnings in the console.

### Additional Information

For more details on using Create React App, refer to the [Create React App documentation](https://create-react-app.dev/docs/getting-started/).
If you encounter any issues, consider checking the documentation or community resources for troubleshooting tips.
23 changes: 22 additions & 1 deletion unisat-web3-demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## Prerequisites

Before you begin, ensure you have the following installed:
- Node.js (version 14.0.0 or later)
- npm (usually comes with Node.js)

## Available Scripts

In the project directory, you can run:
Expand Down Expand Up @@ -37,10 +43,25 @@ If you aren’t satisfied with the build tool and configuration choices, you can

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However, we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

## Debugging Tips

- **Development Server Issues**: If `npm start` fails to run, check for port conflicts or permissions issues.
- **Build Problems**: For errors during `npm run build`, ensure you have the latest versions of dependencies.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

## Community Resources

- [React Reddit](https://www.reddit.com/r/reactjs/)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/create-react-app)

## Examples and Templates

- [Adding TypeScript](https://create-react-app.dev/docs/adding-typescript/)
- [Custom Templates](https://create-react-app.dev/docs/custom-templates/)