Git Product home page Git Product logo

djangoip4's Introduction

Nyumba Kumi

Description

This is a web neighbourhood security app that allows users to create a neighbourhood and post security allerts.

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 https://github.com/BenkiKuu/djangoip4.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 nyumbakumi;

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 Done by my technical mentor Newton Karanu.

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

  • the app is glitchy dislaying comments and registered businesses

Support and contact details

Contact Leo Igane for further help/support

License

MIT

Copyright (c)2018 Leo Igane

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.