-
Notifications
You must be signed in to change notification settings - Fork 82
Closed
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershacktoberfestFor hacktoberfest issue raisesFor hacktoberfest issue raiseshacktoberfest-2022Issues for hacktoberfest on 2022Issues for hacktoberfest on 2022hacktoberfest-acceptedIssue fix accepted for hacktoberfestIssue fix accepted for hacktoberfesthelp wantedExtra attention is neededExtra attention is needed
Description
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
- Checkout to the forked repo with a new branch for each PR/issue
npm installto install all js dependenciesnpm run devto start the local web server- Connect to localhost:3000
- Make changes to the codebase(nextJS and tailwind/plain CSS)
- 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 workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershacktoberfestFor hacktoberfest issue raisesFor hacktoberfest issue raiseshacktoberfest-2022Issues for hacktoberfest on 2022Issues for hacktoberfest on 2022hacktoberfest-acceptedIssue fix accepted for hacktoberfestIssue fix accepted for hacktoberfesthelp wantedExtra attention is neededExtra attention is needed