README.md

GLUG Website Public Repo

We are using django REST framework for backend api.
And Vue.js for frontend.

Click here to refer to the api documentation.

---

Use a virtual envionment for installing this, i.e venv or pipenv.

Install Dependencies

For debian based distro, in virtual evironment terminal type

pip install -r requirements.txt

To run the project on local machine

Create a PostgresSQL database.
Then cp .env.example .env and change .env file according to your need.

Inside project directory type

python3 manage.py makemigrations
python3 manage.py migrate
python3 manage.py collectstatic

# To run with development settings
python3 manage.py runserver --settings=glug_website.dev-settings

Development Environment Config

This project uses PEP8 code style, please make sure to follow. Yapf is our preffered formatting tool. If you are using VSCode add the following in your settings.json

"python.formatting.provider": "yapf",
"python.formatting.yapfArgs": ["--style={based_on_style: pep8, indent_width: 4, column_limit: 120}"],
"python.linting.enabled": true