Django React Typescript Save
A boilerplate with Django on the backend, React on the frontend, and much more!
Project README
Your favorite React-Django boilerplate.
About
This is a fully-featured Django-React boilerplate built for great development experience and easy deployment.
Global
- Commit lint rules
Frontend
| Other features | Status |
|---|---|
| SSR ready | In progress |
| Service workers | ✔️ |
| Gzip static file gen | ✔️ |
| Cache control | ✔️ |
| Code split and lazy loading | ✔️ |
| Google Analytics ready | ✔️ |
| PWA ready | ✔️ |
Backend
- Django
- Django REST Framework
- Django CORS Headers
| Other features | Status |
|---|---|
| Token authentication | ✔️ |
| SMTP ready | ✔️ |
Infrastructure
- Docker image featuring
- Supervisor (optional, should be used if you're deploying on a non-virtualized system)
| Other features | Status |
|---|---|
| NGINX config file | ✔️ |
CI/CD to any V.M. (AWS EC2s, GCloud apps, Digital Ocean droplets, Hostgator VPSs, etc) accessible via SSH (the hml and prd branches will trigger the deploy workflow) |
✔️ |
CI/CD to deploy straight on host (without virtualization; not recommended) (the branch prd-host will trigger this. See more on the host deploy workflow method) |
✔️ |
Integrations
Development directions
- Clone this repo:
git clone https://github.com/marcelovicentegc/django-react-typescript.git - Create a virtual environment:
python -m venv venv - Activate it ☝️:
source venv/bin/activateorvenv\Scripts\activateif you're on a Windows - Install dependencies:
npm i && pip install -r requirements.txt && cd frontend && npm i - Setup the project
.envfile by taking as example the.env.exampleon the root folder (refer to configuration for more details) - Setup the frontend app's
frontend/.envfile by taking as example thefrontend/.env.examplefile (refer to configuration for more details) - Start the application:
npm start(make sure Postgres is up and running)
Configuration
You should configure these variables on a .env file on the root folder for the global configuration and a .env file for the frontend configuration under frontend/.env when developing. As for deploying the app, you will need to set the same set of dev variables + some variables exclusively used in production environments as secrets.
Global
| Environment variable | Default | Description |
|---|---|---|
| SECRET_KEY | w%h-ok)&7l2e@1&ht!#ol3!!qg9zwz9hs$wf@fk4e0-7x1r*#d | Django's SECRET_KEY used to encrypt passwords. It can be generated by running: python -c 'from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())' |
| CDN_NAME | - | Cloudinary's CDN name |
| CDN_API_KEY | - | Cloudinary's CDN API key |
| CDN_API_SECRET | - | Cloudinary's CDN API secret |
| DB_HOST | - | Database host name |
| DB_NAME | - | Database name |
| DB_USER | - | Database user |
| DB_PASSWORD | - | Database password |
| DB_PORT | - | Databse port |
| SMTP_HOST_USER | Your SMTP email (should be a GMail one) | |
| SMTP_HOST_PASSWORD | - | Your SMTP email password |
| TEST | 0 | Used to test the app on the pipeline |
| TWILIO_ACCOUNT_SID | - | Your Twilio account SID (optional) |
| TWILIO_AUTH_TOKEN | - | Your Twilio account Auth token(optional) |
| TWILIO_WPP_NUMBER | - | Your Twilio account's Whatsapp number (optional) |
Exclusively used in production
| Environment variable | Must be |
|---|---|
| IMAGE_NAME | Docker image name (for HML, it will append -hml on its name) |
| MODE | production. This is hardcoded on the Dockerfile |
| ALLOWED_HOSTS | A set of hosts allowed to pass CORS policy. I.g: "www.example.com" "example.com" |
| HML_ALLOWED_HOSTS | Same as ALLOWED_HOSTS but for a HML environment |
| DEPLOY_TOKEN | A Github token with permission to pull this project's image from your Github registry |
| HML_DEPLOY_TOKEN | Same as DEPLOY_TOKEN but for a HML environment |
| HOST | The domain under which your site will be hosted (i.g.:example.com) |
| HML_HOST | Same of HOST but for a HML environment (i.g.: hml.example.com) |
| SSH_PRIVATE_KEY | The SSH key used to access the host machine (currently, one for both PROD and HML environments) |
| USERNAME | The SSH username used to access the host machine (currently, one for both PROD and HML environments) |
Frontend
| Environment variable | Default | Description |
|---|---|---|
| NODE_ENV | development |
Let's Webpack know when to build files to correct public path, optimize code and when to prepend localhost for API endpoints or not. Values must be either development or production. This is hardcoded on the Dockerfile |
| AUTH_TOKEN | - | An auth key generated on Django's admin that must be associated to a user with specific permissions (i.g.: read specific infos from Django's ORM) |
| GTAG_ID | - | Google Analytics ID |
Exclusively used in production
| Environment variable | Must be |
|---|---|
| HML_AUTH_KEY | Same as AUTH_KEY but for a HML environment |
| HML_GTAG_ID | Same as GTAG_ID but for a HML environment |
Deployment worfklows
Virtualized Deploy Workflow
Branches hml and prd will trigger this workflow.
Host Deploy Workflow
For this kind of deploy to work, you will need a running Postgres database, Nginx, and Supervisor processes.
Basic architecture
Open Source Agenda is not affiliated with "Django React Typescript" Project. README Source: marcelovicentegc/django-react-typescript
Stars
326
Open Issues
12
Last Commit
2 months ago
Repository
License
Open Source Agenda Badge
