Skip to content
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

Jump to bottom

Add Instructions to run the project locally #19

Open
dennyabrain opened this issue Jul 8, 2020 · 2 comments
Open

Add Instructions to run the project locally #19

dennyabrain opened this issue Jul 8, 2020 · 2 comments
Assignees
@surajsharma
Labels
documentation Improvements or additions to documentation
Milestone
Build a high qual...

Comments

@dennyabrain
Copy link
Contributor

in the root README.md create a section called 'Developing Locally' that lists steps to run the project on your local machine. If any of the steps for a particular component is complex or multi-step, add that to the README of that component. For instance src/api/README.md and link in the root README.md

The goal is to enable anyone to spin this up locally and start developing new features.
@dennyabrain dennyabrain added the documentation Improvements or additions to documentation label Jul 8, 2020
@surajsharma
Copy link
Contributor

have added this to my master, please review and merge

@dennyabrain
Copy link
Contributor Author

@surajsharma did this get lost somewhere in all the merges we did? I dont see any READMEs anymore.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@surajsharma surajsharma

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Build a high quality Whatsapp Archive
Development

No branches or pull requests
2 participants
@dennyabrain @surajsharma