/backend- The Django backend API server./frontend- The React web app frontend.
- React
- Django
- Building a React.js Application using Django REST Framework
- dbdiagram.io - Visualize dbml Files
- Caddy
- Postman Testing requests to backend & other external API's
- SQLite Browsing data in database
- Signal E2e private messenger for sending/receiving secret tokens
Follow the steps outlined in the Backend setup guide
Follow the steps outlined in the Frontend setup guide
Our project will use a .env file that contains different variables and secrets that will be used for both development and production. Contact @NoahCardoza#3669 for more info regarding the Google client_id and secrets, which will be sent via Signal Messenger.
To get started, copy the sample .env file to the project root directory with the filename: .env.
Same as above, but save file as: prod.env.
Install Caddy:
- For Windows, a copy of
caddy.exeis already included for easy development. - On Linux and macOS, install Caddy through your package manager.
- You can also download it manually from Caddy's website if you prefer.
After following the setup directions in both backend and frontend README file, to get a complete development setup instantly, enter the poetry virtual environment shell and run this command in the project's root folder. This will start the Django, Caddy and Vite instances. You can access the development app on http://localhost:80
node run.js
To emulate production mode without Docker:
cd frontend
npm run build
cd ..
node run.js production
If you are using VSCode, you can simply copy .vscode/settings.example.json to .vscode/settings.json
and install the recommended extensions
inside .vscode/extensions.json.