🔧 Created Makefile and updated README #535
Conversation
backend/README.md
Outdated
|
|
||
| [//]: # ( ) | ||
|
|
||
| [//]: # (- Finally, run `psql -h localhost -d postgres -U penn-courses -f pcx_test.sql` (replacing `pcx_test.sql` with the full path to that file on your computer) to load) |
There was a problem hiding this comment.
Why is it formatted like this ?
| # Commands | ||
| runserver: | ||
| PIPENV_VERBOSITY=-1 | ||
| pipenv run python manage.py runserver 0.0.0.0:8000 |
There was a problem hiding this comment.
Nit, but why not just use 127.0.0.1?
| @@ -9,6 +9,10 @@ Welcome to the Penn Courses Backend (PCX)! | |||
|
|
|||
| ### Running the Backend with Docker-Compose | |||
There was a problem hiding this comment.
I think we should move the local dev environment thing to the top, and move down Running the backend with Docker-Compose.
| 3. `python manage.py migrate` | ||
|
|
||
| 5. Loading test data (if you are a member of Penn Labs). If you are not a member of Penn Labs, you can skip this section and load in course data from the registrar, as explained below. | ||
| 4. Migrate Django models |
There was a problem hiding this comment.
Hmm, I think using make for simple things like migrate/makemigrations could end up being a leaky abstraction as we will not provide make commands for all the commands they might run (e.g., management commands or manage.py shell).
IMO, I think we should add make commands for the installation, but otherwise ask people to use python manage.py xxx.
| python manage.py migrate | ||
|
|
||
| # Lint | ||
| lint: |
backend/Makefile
Outdated
| python manage.py makemigrations | ||
|
|
||
| # Migrate (when migrations are created) | ||
| migrate: |
There was a problem hiding this comment.
I don't think we should abstract away the python manage.py xxx commands (see my comment on the readme)
No description provided.