Update README with getting started section#745
Update README with getting started section#745yeshwanthp7 wants to merge 1 commit intoaccordproject:mainfrom
Conversation
Added prerequisites and installation instructions to the README.
✅ Deploy Preview for ap-template-playground ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR adds a "Getting Started" section to the README to improve onboarding for new contributors and users. The section includes prerequisites (Node.js and npm versions), installation instructions, and aims to provide setup guidance for running the project locally.
Changes:
- Added "Getting Started" section with prerequisites and installation steps
- Positioned the new section before the Demo section in the README
| ## Getting Started | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - Node.js >= 18 (LTS recommended) | ||
| - npm >= 9 | ||
|
|
||
| ### Installation | ||
|
|
||
| ```bash | ||
| git clone https://github.com/accordproject/template-playground.git | ||
| cd template-playground | ||
| npm install |
There was a problem hiding this comment.
The Getting Started section is incomplete. According to the PR description, this should include "Instructions to run the project locally," but only installation steps are provided. Please add a "Running Locally" or "Development" subsection after Installation that includes the command to start the development server (e.g., npm run dev based on package.json scripts).
| ### Prerequisites | ||
|
|
||
| - Node.js >= 18 (LTS recommended) | ||
| - npm >= 9 |
There was a problem hiding this comment.
The npm version requirement doesn't match the package.json specification. The package.json defines "npm": ">=6" (line 8), but this documentation states "npm >= 9". Please align this with the actual package.json requirement, which is npm >= 6.
| - npm >= 9 | |
| - npm >= 6 |
| ```bash | ||
| git clone https://github.com/accordproject/template-playground.git | ||
| cd template-playground | ||
| npm install |
There was a problem hiding this comment.
The code block is not properly closed. The bash code block starting at line 51 is missing the closing triple backticks. This should be added after the "npm install" line (line 54) to properly format the code block.
Summary
This PR adds a Getting Started section to the README.
It includes:
This improves onboarding for new contributors and users.