You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 06a61dd
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+16-3Lines changed: 16 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,17 +72,18 @@ pipenv install --dev
72
72
73
73
### Environment variables
74
74
75
-
Set the environment variables. Start by writing this in a file named `local.env`:
75
+
Start by writing this in a file named `.env`:
76
76
77
77
```prolog
78
-
SECRET_KEY=some_random_characters_here
79
-
DB_URI=postgresql://user:password@db:5432/twt
78
+
SECRET_KEY=
79
+
POSTGRES_URI=
80
80
DISCORD_CLIENT_ID=
81
81
DISCORD_CLIENT_SECRET=
82
82
```
83
83
84
84
And fill in the variables with the values below:
85
85
86
+
-`REDIS_URI` is the Redis server URI.
86
87
-`POSTGRES_URI` is the PostgreSQL database URI.
87
88
-`SECRET_KEY` is the key used for JWT token encoding.
88
89
-`TEST_POSTGRES_URI` is the PostgreSQL database URI for tests.
@@ -95,6 +96,13 @@ And fill in the variables with the values below:
95
96
96
97
Run the API and initialise the database:
97
98
99
+
#### Make sure submodules are up to date.
100
+
> If you have not initialized submodules use this command:\
101
+
> `git submodule update --init`
102
+
>
103
+
> To update submodules:\
104
+
> `git submodule foreach git pull`
105
+
98
106
```sh
99
107
pipenv run python launch.py runserver --initdb
100
108
```
@@ -111,6 +119,11 @@ Both the API and the [frontend](https://github.com/Tech-With-Tim/Frontend) can b
111
119
112
120
- Then make sure you have `docker` and `docker-compose` installed, if not read [this for docker](https://docs.docker.com/engine/install/) and [this for docker compose](https://docs.docker.com/compose/install/).
113
121
122
+
- If you have not already, create a local network called `twt`
0 commit comments