Website/README.md

972 B

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
  • 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 this starts the website at localhost:3030

Structure

The website has a Home page and a News page currently. The News page shows all developer blogs.

Problems and Development

Currently, there are the following problems:

  • the page needs a Dark Mode
  • Ability for staff to add blogs directly

If you find any problems and have a solution in code then please consider making a pull request, using the Create a new branch for this commit and start a pull request option with an appropriate branch name.