diff --git a/brc20-market-demo/README.md b/brc20-market-demo/README.md index 5feaab6..fba8788 100644 --- a/brc20-market-demo/README.md +++ b/brc20-market-demo/README.md @@ -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. \ No newline at end of file diff --git a/brc20-swap-demo/README.md b/brc20-swap-demo/README.md index 7573d67..5751ec9 100644 --- a/brc20-swap-demo/README.md +++ b/brc20-swap-demo/README.md @@ -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. diff --git a/unisat-inscribe-demo/README.md b/unisat-inscribe-demo/README.md index 0b6a9a9..8f2596c 100644 --- a/unisat-inscribe-demo/README.md +++ b/unisat-inscribe-demo/README.md @@ -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. diff --git a/unisat-web3-demo/README.md b/unisat-web3-demo/README.md index b87cb00..b8beea3 100644 --- a/unisat-web3-demo/README.md +++ b/unisat-web3-demo/README.md @@ -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: @@ -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/) \ No newline at end of file