Bootstrap Django API #419

aaronxsu · 2022-03-10T00:49:58Z

Overview

This PR:

adds django and database services for local dev as API and DB
adds/updates ./scripts/bootstrap, ./scripts/setup, ./scripts/update, ./scripts/manage, ./scripts/server, ./scripts/dbshell
adds a simple /api/ API route and returns a message that shows the API works as expected
adds a small test on the frontend to allow testing the communication with local dev API

Notes

I made some notes as single comments in the files changed below. Feel free to discuss!
I did not add in Vagrant in this solution, and would like to propose to start from just using Docker. If we find it easier to add Vagrant as a layer in between in the future, I'd be happy to take that issue as well.

Testing Instructions

Make sure your local docker app is running
At the root of the directory, run ./scripts/setup, which should bootstrap the app, install deps, build containers, and run migrations
Run ./scripts/server, which should spin up a local DB, frontend, and Django API server
After the Django API is up and running, make sure the following is successful

curl --location --request GET 'http://localhost:8081/api'

Go to http://localhost:9966, open your network tabs in the dev tools, and filter to the /api/ call. Make sure the request is also successful
At the root of the directory, run ./scripts/manage migrate and make sure it runs migrations, although there is no migration to run now, which is fine
~~At the root of the directory, run ./scripts/dbshell and make sure it takes you to a local psql shell and you could do normal SQL stuffs there~~

Resolves #414

backend/Dockerfile

backend/echo/settings.py

backend/api/views.py

scripts/bootstrap

scripts/dbshell

README.md

backend/echo/settings.py

backend/requirements.txt

docker-compose.yml

ddohler

Thanks for putting this together! Overall, this looks really good. I found some smaller things that I think need to be addressed, and some larger architecture discussion items that might potentially lead to more work, or to other issues being created. Let me know what you think!

README.md

scripts/server

scripts/update

docker-compose.yml

scripts/dbshell

backend/api/views.py

backend/echo/settings.py

ddohler

This is working well! I found a few more things that I think should be changed but it looks like they've all got pretty easy resolutions, so this is good to go after cleaning those up!

README.md

backend/api/views.py

taui/src/index.js

scripts/bootstrap

backend/Dockerfile

docker-compose.yml

scripts/update

taui/src/index.js

taui/package.json

- update docker-compose to include django and database services - add STRTA scripts for local development - bootstrap Django to be used as API backend with necessary dependencies, middleware, db config - update start command in the package.json for frontend so that it can proxy the django API locally - update README for the STRTA section - update gitignore to ignore byte-compiled python files and static files from Django