Skip to content

Commit 5b11236

Browse files
committed
Adding instructions to start using the app for users.
1 parent d3075bb commit 5b11236

2 files changed

Lines changed: 18 additions & 2 deletions

File tree

.env_template

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
POSTGRES_DB=main
22
POSTGRES_USER=admin
33
POSTGRES_PASSWORD=admin
4-
DJANGO_SECRET_KEY=8a72377bee5adeff7158a7f9d5b72a31853a439e8a736c07b98b1051240f18cc
4+
DJANGO_SECRET_KEY=

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,28 @@
99

1010
Project still in development. Expect the backend and frontend to be ready in a couple of weeks.
1111

12-
## Installations
12+
## Installation and running
1313

1414
This project aims to be as fast to spin up as possible. And thus, if you have the appropriate utility installed (<a href="https://docs.docker.com/compose/install/">docker-compose</a> & <a href="https://docs.docker.com/engine/install/">docker cli + engine</a>.
1515

1616
Before going further with any of the two steps, Install <a href="https://kubernetes.io/docs/tasks/tools/">Kubectl</a> to make it easier for you to interact with the kubernetes cluster.
1717

18+
#### Setting up the django project
19+
20+
do:
21+
22+
```
23+
cp .env_template .env
24+
```
25+
26+
Make sure to generate a unique `DJANGO_SECRET_KEY` for your project by running:
27+
28+
```
29+
python3 -c "import secrets; print(secrets.token_hex())"
30+
```
31+
32+
Paste the output into `DJANGO_SECRET_KEY` in your `.env` file. We can definitely use some automation here.
33+
1834
Also, Now the next steps are divided into two categories:
1935

2036
### 1. If you are trying to host it locally:

0 commit comments

Comments
 (0)