The tech stack is React front-end + Django back-end + PostgreSQL database. Our application will be a SPA (Single Page Application), so there will be one index.html and all page routing will be entirely in React. Django will act as a REST framework, where React can call HTTP requests for information. They will both be hosted on the same IP and port for convenience.
-
Page routes can be found in viteapp/src/App.jsx
-
Web API routes can be found in django-main/urls.py
Note: Page routes and Web API routes CANNOT have conflicting names
-
Inside of the src/utils folder, you can find examples of react pages calling django methods. To do this, use await fetch(
/URL_PATH_NAME, { method: 'GET',... -
Database model can be found in apo/models.py
Django consists of one main “project” and a bunch of “apps” that are connected to the project. django-main/ folder is where the main project is. the apo/ folder is an example of an app. Theoretically, this is supposed to help organize our code into app submodules.
- Put the .env file inside of the django-main folder. The django-main folder is the main project folder for Django. This .env file contains information about database connection and is required for the project to run.
- Have npm, pip on your computer. Use Django 3.2.4, as higher versions no longer support Postgres version 10.
- If you want to run the application locally, make sure all Python libraries are installed. You can find them inside the Dockerfile. Then run
python manage.py runserver 8002
- If you want to run the application through Docker, have the daemon running, and call
docker build . -t django-app
then
docker run -p 8002:8002 django-app
- Follow up, to prevent memory accumulation, and clear unused images and containers
- You can modify any files while the server is up, and the server will reload and show new changes
- If you modify something that is part of viteapp, go inside /viteapp/ and call
python manage.py runserver 8002
Changes will be shown after this command is complete. You can call this while the Django server is running or not. 8. Before pushing, test to ensure your code compiles locally and through Docker. Add any additional pip installs to the Dockerfile
Create Python Venv:
python3.11 -m venv venv
sudo source ./venv/bin/activate
Deactivate Python Venv:
sudo source deactivate
Install Dependencies:
pip install --no-cache-dir -r requirements.txt