Mtribune

Moringa Tribunal

Description

This is an application where users can sign in and get the latest news and features from Moringa School. Users can subscribe to the mailing list to get the latest news and features.

Link to deployed site

http://mtr1bune.herokuapp.com/

Table of content

1. Description
2. Setup and installations
3. Deployment
4. Contributing
5. Bugs
6. Contact me
7. Licensing

Setup and installations

Prerequisites

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

Technologies used

- Python 3.6
- HTML
- Bootstrap 4
- Heroku
- Postgresql

Clone the Repo and checkout into the project folder.

git clone git@github.com:newtonkiragu/mtribune-hosting.git && cd mtribune-hosting

Create and activate the virtual environment

python3.6 -m virtualenv virtual

source virtual/bin/activate

Setting up environment variables

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

SECRET_KEY='<Secret_key>'
DBNAME='tribune'
USER='<Username>'
PASSWORD='<password>'
DEBUG=True

EMAIL_USE_TLS=True
EMAIL_HOST='smtp.gmail.com'
EMAIL_PORT=587
EMAIL_HOST_USER='<your-email>'
EMAIL_HOST_PASSWORD='<your-password>'

Install dependancies

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

Create the Database

In a new terminal, open the postgresql shell with psql.

CREATE DATABASE tribune;

Make and run migrations

python3.6 manage.py makemigrations && python3.6 manage.py migrate

Run the app

python3.6 manage.py runserver

Open localhost:8000

Deployment

To deploy the application, please follow the instructions in this gist

Contributing

Please read this comprehensive guide on how to contribute. Pull requests are welcome :-)

Bugs

Create an issue mentioning the bug you have found

Known bugs

• cannot subscribe to email list in live application

Support and contact details

Contact Newton Karanu for further help/support

License

MIT

Copyright (c)2018 Newton Karanu