Skip to content

Update README with getting started section #745

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.

Sign up for GitHub

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

Open
yeshwanthp7 wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −0
Open

Update README with getting started section #745

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,19 @@ The Accord Project Playground is an open-source project, welcoming contributions
- **Documentation and Tutorials:** Contribute to comprehensive documentation and tutorials that guide users through the platform effectively.

## Demo
## Getting Started

### Prerequisites

- Node.js >= 18 (LTS recommended)
- npm >= 9
Copy link

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
- npm >= 9
- npm >= 6

Copilot uses AI. Check for mistakes.

### Installation

```bash
git clone https://github.com/accordproject/template-playground.git
cd template-playground
npm install
Comment on lines +42 to +54
Copy link

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copilot uses AI. Check for mistakes.
Comment on lines +51 to +54
Copy link

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.

The Template Playground is deployed at: [https://playground.accordproject.org](https://playground.accordproject.org)

Expand Down
Loading