Before you begin a new development - Aimlackies/Reporter GitHub Wiki

Follow these basic instructions before starting work on any new feature.

  1. Get the latest changes from the repository / branch

    git pull
    

    Note: You should also change to a new branch before moving any further, if not already done so.

  2. Set system environment varables for the Flask application. The first tells the Flask command the file to run on startup and the second will cause the Flask application to start in development mode.

    Windows:

    SET FLASK_APP=reporter.py
    SET FLASK_ENV=development
    

    Unix based systems:

    export FLASK_APP=reporter.py
    export FLASK_ENV=development
    
  3. Update the database

    make sure your local database is up-to-date with the latest changes

    flask db upgrade
    

    Note: To generate a new migration once modifying models.py, run the command flask db migrate -m "migration message".

  4. Start the application.

    You're done! All that is left now is to start the application and start developing!

    flask run