local.md

Local development

Want to contribute? Great!

Prerequisites

Fork meilix-generator and meilix onto your account. You need special permissions to test and deploy.

# clone meilix repo
$ git clone https://github.com/<your_username>/meilix.git meilix

# clone meilix-generator into separate directory
$ git clone https://github.com/<your_username>/meilix-generator.git meilix-generator

Get started by installing the virtual environment

$ sudo pip install virtualenv

cd into the cloned repository and start the virtual environment

$ cd meilix-generator
$ virtualenv venv

Activate the virtual environment

$ source venv/bin/activate

Install all dependencies(frameworks, templating...)

$ sudo pip install -r requirements.txt

Run locally

Adding application

$ export FLASK_DEBUG=1 FLASK_APP=app.py

Run the application

$ flask run

Now your app should be running on http://127.0.0.0:5000.

Note: Make sure to generate your own tokens and API keys. Refer to my_token.md for details.

Look at heroku installation on how to test and deploy on Heroku