mucciz / book-grao-v3

Flask template

i am a flask template

Description

I am a template to be used to develop flask application ready for production.

Link to deployed site

....

Table of content

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

Setup and installations

Prerequisites

1. Python3.6 )
2. virtualenv
3. Pip

Technologies used

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

Clone the Repo and rename it to suit your needs.

git clone [email protected]:newtonkiragu/flask-template.git

Initialize git and add the remote repository

git init

git remote add origin <your-repository-url>

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>'
DEBUG=True

Install dependancies

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

Make and run migrations

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

Run the app

python3.6 manage.py runserver

Open localhost:5000

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

• N/A

Support and contact details

Contact Newton Karanu for further help/support

License

MIT

Copyright (c)2018 Newton Karanu