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.

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

Document how to run locally #57

Open
bertday opened this issue Sep 23, 2021 · 2 comments
Open

Document how to run locally #57

bertday opened this issue Sep 23, 2021 · 2 comments

Comments

@bertday
Copy link

bertday commented Sep 23, 2021

I was looking for some instructions on how to run the app locally and didn't see anything in README.md. Did I maybe just miss this, or can I help with adding some notes? 😄

@smattingly
Copy link
Contributor

@rbrtmrtn I get the impression you are looking at the main branch; you might have better luck with develop. I can't speak to all the branch management, but my impression is that main is pretty stale (but represents the production deploys?) while develop is the destination for merging various feature branches.
In the develop branch README, this is at the end of the setup section:

After that you should be able to serve the backend and frontend by running in both server and client folders.
yarn run serve

I think that was added when @hcdeng and I joined about a month ago.

IOW, execute yarn run serve (or just yarn serve) in the packages/server directory to start the API backend on port 3000, and the same command in the packages/client directory to start the app on port 8080.

@bertday
Copy link
Author

bertday commented Sep 30, 2021

@smattingly Thank you for following up on this and for the helpful notes on main vs. develop. I'll give this another try on develop using that README!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants