newtonkiragu / events

Events Planners

A site that is used to host events.

Description

A web application that that helps people find events

Behaviour Specifications

Table of content

1. Description
2. Setup and installations
3. Contributing
4. Bugs
5. License

Setup and installations

Prerequisites

1. Python3.6
2. Postgres
3. virtualenv
4. Pip

Technologies used

- Python 3.6
- Django
- Postgresql

Clone the Repo and enter the project folder.

git clone [e-mail]:newtonkiragu/events.git && cd events

Create and activate the virtual environment

python3.6 -m virtualenv venv

source venv/bin/activate

Create Database

Create a database on your local machine

Setting up environment variables

Create a .env file and paste paste the following filling where appropriate:

SECRET_KEY='<secret_key>'
DB_NAME='events'
DB_USER='<username>'
DB_PASSWORD='<paswword>'
DB_HOST='localhost'
DB_PORT='5432'
DEBUG=True
ALLOWED_HOSTS='*'
MODE='dev'
SENDGRID_API_KEY='yourapikey'

Install dependencies

Install dependencies that will create an environment for the app to run pip install -r requirements.txt

Run migrations

python3.6 manage.py migrate

Run the app

python3.6 manage.py runserver

Open localhost:8000

Contributing

Please read this comprehensive guide on how to contribute. Pull requests are welcome!

Bugs

No known bugs if a bug is found create an issue in the issues section of the repository.