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

Better documentation for initial setup of the dev environment #3

Open
2 of 5 tasks
daemontus opened this issue Oct 19, 2023 · 0 comments
Open
2 of 5 tasks

Better documentation for initial setup of the dev environment #3

daemontus opened this issue Oct 19, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@daemontus
Copy link
Member

Right now, the README describes how to run the database, the backend and the frontend. However, it does not describe how to populate the database with models, or how to update it afterwards (plus I had a few issues with port settings).

In the final documentation, we should have instructions on how to setup everything. In particular:

  • How to start/stop the database using docker.
  • How to load data into the database and update it if necessary ("updating" the raw data can be just copying from the other github repository).
  • How to check/setup the database connection: I had to set the DATABASE_URL environment variable with the correct URL, including user, password, port, and database. It would be good to just write this down somewhere in case someone not familiar with the project needs to run it locally.
  • I had to change the port in frontend/src/services/base.ts to 3000 (instead of 3001). I'm guessing in the final version, this URL will probably be another environment variable? Or some kind of configuration option?
  • How to start the dev server for backend and frontend.
@StarLord1337 StarLord1337 added the documentation Improvements or additions to documentation label Oct 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants