Skip to content

Commit 8600073

Browse files
committed
updated README.md
1 parent 3638d88 commit 8600073

File tree

1 file changed

+13
-30
lines changed

1 file changed

+13
-30
lines changed

README.md

Lines changed: 13 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,21 @@
11
# German Words
22

3-
Backend for German Words
3+
## Getting Started
44

5-
## Run Production Server Locally
5+
### Initialize Client
66

7-
```sh
8-
SECRET_KEY='GET_DATA'
9-
DEBUG='False'
10-
ENVIRONMENT='PROD'
11-
DATABASE_URL="GET_DATA"
12-
```
7+
* Steps are mentioned [here](src/client/README.md)
138

14-
* Command: `python src/manage.py runserver 8080`
9+
### Initialize Server
1510

16-
## Versions
11+
* Clone the repository.
12+
* Create the `.env` file from `.env-template`.
13+
* Upgrade pip: `python -m pip install --upgrade pip`
14+
* Installing packages: `pip install -r requirements.txt`
15+
* Migrating Database:
16+
* `python3 manage.py makemigrations`
17+
* `python3 manage.py migrate`
1718

18-
* Font Awesome: 6.5.1
19-
* Bootstrap 5.3
19+
### Create Super User
2020

21-
## Workflow:
22-
23-
### Data Listing
24-
25-
* Stuff member adds the data.
26-
* Admin will have to approve the data.
27-
* Only approved data will be listed in list view.
28-
29-
## Resources
30-
31-
* [crispy-bootstrap5](https://github.com/django-crispy-forms/crispy-bootstrap5)
32-
* [font-awesome-6.5.1](https://use.fontawesome.com/releases/v6.5.1/fontawesome-free-6.5.1-web.zip)
33-
* Installed using cdn with [cdnjs.com](https://cdnjs.com/libraries/font-awesome)
34-
* Deprecated: [Python/Django Installation Guideline](https://fontawesome.com/docs/web/use-with/python-django)
35-
36-
## Allauth Pages Updated
37-
38-
* `accounts/*.html`
21+
* `python manage.py create_superuser`

0 commit comments

Comments
 (0)