updated the README.md

pull/6/head
Jukoga 2024-08-05 13:13:59 +02:00
parent 2e1fd94c8f
commit c916a2f583
1 changed files with 18 additions and 8 deletions

View File

@ -1,13 +1,23 @@
## Requirements
The website requires the following:
- Docker
- Docker Compose
- A running MariaDB Instance
## Deployment
To deploy the website:
To deploy the website:
- first clone the repository to any local folder
- then open the folder with the `manage.py` file
- then `Shift`+`Right Click` and click on `Open PowerShell window here`
- then create the virtual environment by typing `py -m venv .venv`
- then activate the virtual environment by typing `.venv\Scripts\Activate`
- then install the requirements by typing `pip install -r requirements.txt`
- then type in `py manage.py runserver 3000`
- open browser at address `localhost:3000` or `127.0.0.1:3000`
- then open the folder
- create a new file called `.env` and add the following:
```
SECRET_KEY=your_secret_key
DB_NAME=your_db_name
DB_USER=your_db_user
DB_PASSWORD=your_db_password
DB_HOST=your_db_host
DB_PORT=your_db_port
```
- run `docker-compose up --build` to start the website
## Structure
The website has a Home page and a News page currently. The News page shows all developer blogs.