Skip to content

Commit b1eda9c

Browse files
docs: remove duplicate config var and detail workflows
1 parent a86e50f commit b1eda9c

File tree

1 file changed

+28
-15
lines changed

1 file changed

+28
-15
lines changed

README.md

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,12 @@ This is a fully-featured Django-React boilerplate built for great development ex
5252
- [Memcached](https://memcached.org/)
5353
- [PostgreSQL](https://www.postgresql.org/)
5454

55-
| Other features | Status |
56-
| -------------------------------------------------------------------------------------------------------------------- | ----------- |
57-
| NGINX config file | ✔️ |
58-
| CI/CD to Digital Ocean Droplet (the `hml-do` and `prd-do` branches will trigger Digital Ocean's deployment workflow) | ✔️ |
59-
| CI/CD to AWS (the `hml-aws` and `prd-aws` branches will trigger AWS' deployment workflow) | In progress |
60-
| CI/CD to Google Cloud (the `hml-gc` and `prd-gc` branches will trigger GCloud's deployment workflow) | In progress |
55+
| Other features | Status |
56+
| ------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
57+
| NGINX config file | ✔️ |
58+
| CI/CD to Digital Ocean Droplet (the `hml-do` and `prd-do` branches will trigger [Digital Ocean's deploy workflow](#Digital-Ocean-Droplet)) | ✔️ |
59+
| CI/CD to AWS (the `hml-aws` and `prd-aws` branches will trigger [AWS' deploy workflow](#AWS-Workflow)) | In progress |
60+
| CI/CD to Google Cloud (the `hml-gc` and `prd-gc` branches will trigger [GCloud's deployment workflow](#Google-Cloud-Workflow)) | In progress |
6161

6262
### Integrations
6363

@@ -74,7 +74,7 @@ This is a fully-featured Django-React boilerplate built for great development ex
7474
4. Install dependencies: `npm i && pip install -r requirements.txt && cd frontend && npm i`
7575
5. Setup the project `.env` file by taking as example the `.env.example` on the root folder (refer to [configuration](#Configuration) for more details)
7676
6. Setup the frontend app's `frontend/.env` file by taking as example the `frontend/.env.example` file (refer to [configuration](#Configuration) for more details)
77-
7. Start the application: `npm start`
77+
7. Start the application: `npm start` (make sure Postgres is up and running)
7878

7979
## Configuration
8080

@@ -104,7 +104,7 @@ You should configure these variables on a `.env` file on the root folder for the
104104

105105
| Environment variable | Must be |
106106
| -------------------- | ---------------------------------------------------------------------------------------------------- |
107-
| MODE | `production` |
107+
| MODE | `production`. This is hardcoded on the [Dockerfile](./Dockerfile) |
108108
| ALLOWED_HOSTS | A set of hosts allowed to pass CORS policy. I.g: "www.example.com" "example.com" |
109109
| HML_ALLOWED_HOSTS | Same as ALLOWED_HOSTS but for a HML environment |
110110
| DEPLOY_TOKEN | A Github token with permission to pull this project's image from your Github registry |
@@ -116,26 +116,39 @@ You should configure these variables on a `.env` file on the root folder for the
116116

117117
### Frontend
118118

119-
| Environment variable | Default | Description |
120-
| -------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
121-
| NODE_ENV | `development` | |
122-
| 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) |
123-
| GTAG_ID | - | Google Analytics ID |
119+
| Environment variable | Default | Description |
120+
| -------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
121+
| 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](./Dockerfile) |
122+
| 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) |
123+
| GTAG_ID | - | Google Analytics ID |
124124

125125
#### Exclusively used in production
126126

127127
| Environment variable | Must be |
128128
| -------------------- | ------------------------------------------ |
129-
| NODE_ENV | `production` |
130129
| HML_AUTH_KEY | Same as AUTH_KEY but for a HML environment |
131130
| HML_GTAG_ID | Same as GTAG_ID but for a HML environment |
132131

133-
## Deployment worfklow
132+
## Deployment worfklows
134133

135134
### Digital Ocean Droplet
136135

136+
Branches `hml-do` and `prd-do` will trigger this workflow.
137+
137138
![Digital Ocean Droplet deploy workflow](./assets/DigitalOceanDeploySteps.jpg)
138139

140+
### AWS Workflow
141+
142+
Branches `hml-aws` and `prd-aws` will trigger this workflow.
143+
144+
In progress...
145+
146+
### Google Cloud Workflow
147+
148+
Branches `hml-gc` and `prd-gc` will trigger this workflow.
149+
150+
In progress...
151+
139152
## Basic architecture
140153

141154
![Architecture](./assets/Architecture.png)

0 commit comments

Comments
 (0)