Skip to content

Commit a259df8

Browse files
committed
chore: readme file setup
1 parent c5c27b5 commit a259df8

File tree

1 file changed

+17
-20
lines changed

1 file changed

+17
-20
lines changed

Readme.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
[![Status](https://img.shields.io/website-up-down-green-red/https/www.chatapp-be-api.herokuapp.com/health.svg)](https://chatapp-be-api.herokuapp.com/)
21
[![Python Version](https://img.shields.io/badge/python-3.8-blue.svg)](https://www.python.org/)
32
[![Django Version](https://img.shields.io/badge/django%20versions-3.0-blue.svg)](https://www.djangoproject.com/)
43
[![Made with React](https://img.shields.io/badge/made%20with-React-orange.svg)](https://reactjs.org/)
@@ -16,6 +15,22 @@ Follow these instructions, to get a copy and run on your PC
1615
2. Virtual Environment Installed (recommended not compulsory)
1716
3. Pyhthon 3.8 installed globaly or within the VirtualEnv
1817

18+
19+
### Environmental Variables
20+
21+
| Name | Required | Value |
22+
|------|----------|---------|
23+
| `SECRET_KEY` | :heavy_check_mark: | String, standard Django setting |
24+
| `ALLOWED_HOSTS` | :heavy_check_mark: | `localhost` |
25+
| `DEBUG` | :heavy_check_mark: | Boolean, standard Django setting |
26+
| `DATABASE_URL` | :x: | standard Django setting |
27+
| `SQL_ENGINE` | :heavy_check_mark: | standard Django setting |
28+
| `SQL_DATABASE` | :heavy_check_mark: | standard Django setting |
29+
| `SQL_USER` | :heavy_check_mark: | standard Django setting |
30+
| `SQL_PASSWORD` | :heavy_check_mark: | standard Django setting |
31+
| `SQL_HOST` | :heavy_check_mark: | standard Django setting |
32+
| `REDIS_URL` | :heavy_check_mark: | standard Django setting |
33+
1934
#### Frontend
2035

2136
- [Node.js](https://nodejs.org/en/download/)
@@ -46,25 +61,7 @@ Follow these instructions, to get a copy and run on your PC
4661
pip install -r requirements.txt
4762

4863
4. Create the environment file `.env` on the root directory
49-
50-
### Environmental Variables
51-
52-
| Name | Required | Value |
53-
|------|----------|---------|
54-
| `SECRET_KEY` | :heavy_check_mark: | String, standard Django setting |
55-
| `ALLOWED_HOSTS` | :heavy_check_mark: | `localhost` |
56-
| `DEBUG` | :heavy_check_mark: | Boolean, standard Django setting |
57-
| `DATABASE_URL` | :x: | standard Django setting |
58-
| `SQL_ENGINE` | :heavy_check_mark: | standard Django setting |
59-
| `SQL_DATABASE` | :heavy_check_mark: | standard Django setting |
60-
| `SQL_USER` | :heavy_check_mark: | standard Django setting |
61-
| `SQL_PASSWORD` | :heavy_check_mark: | standard Django setting |
62-
| `SQL_HOST` | :heavy_check_mark: | standard Django setting |
63-
| `REDIS_URL` | :heavy_check_mark: | standard Django setting |
64-
65-
Use this as an example (do not copy😀):
66-
67-
```
64+
Use this as an example (do not copy😀):
6865
SECRET_KEY=choose-a-secreat-key
6966
DEBUG=True
7067
ALLOWED_HOSTS = *

0 commit comments

Comments
 (0)