Skip to content

[Bug]: update Readme with npm cmds #145

@jsvigneshkanna

Description

@jsvigneshkanna

Bug Title

Update readme

Description of BUG

The readme of the repo doesn't have npm commands that we use during development. Add those to the readme

Add the below points under the cotribution section

  1. Checkout to the forked repo with a new branch for each PR/issue
  2. npm install to install all js dependencies
  3. npm run dev to start the local web server
  4. Connect to localhost:3000
  5. Make changes to the codebase(nextJS and tailwind/plain CSS)
  6. Commit changes and raise PR

Reporduction URL of bug

Nill

Bug Issue Type

Documentation

Screenshot of the issue if in UI/ Document

Nill

Are you taking this issue fix

Up for grabs

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingdocumentationImprovements or additions to documentationgood first issueGood for newcomershacktoberfestFor hacktoberfest issue raiseshacktoberfest-2022Issues for hacktoberfest on 2022hacktoberfest-acceptedIssue fix accepted for hacktoberfesthelp wantedExtra attention is needed

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions