updated the README.md

README.md

@@ -1,13 +1,23 @@
+## Requirements
+The website requires the following:
+- Docker
+- Docker Compose
+- A running MariaDB Instance
+
 ## Deployment
 To deploy the website:
 - first clone the repository to any local folder
-- then open the folder with the `manage.py` file
+- then open the folder
-- then `Shift`+`Right Click` and click on `Open PowerShell window here`
+- create a new file called `.env` and add the following:
-- then create the virtual environment by typing `py -m venv .venv`
+```
-- then activate the virtual environment by typing `.venv\Scripts\Activate`
+SECRET_KEY=your_secret_key
-- then install the requirements by typing `pip install -r requirements.txt`
+DB_NAME=your_db_name
-- then type in `py manage.py runserver 3000`
+DB_USER=your_db_user
-- open browser at address `localhost:3000` or `127.0.0.1:3000`
+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.