https://github.com/spotlightkid/fmchallenge-webapp
Dynamic web site for the Open Source FM Synthesizer Challenge
https://github.com/spotlightkid/fmchallenge-webapp
Last synced: 6 months ago
JSON representation
Dynamic web site for the Open Source FM Synthesizer Challenge
- Host: GitHub
- URL: https://github.com/spotlightkid/fmchallenge-webapp
- Owner: SpotlightKid
- License: bsd-3-clause
- Archived: true
- Created: 2018-09-14T16:30:10.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-05-01T20:32:09.000Z (over 2 years ago)
- Last Synced: 2025-03-20T12:49:22.186Z (10 months ago)
- Language: Python
- Size: 190 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
===============================
FM Challenge Web App
===============================
Dynamic web site for the Open Source FM Synthesizer Challenge
Quickstart
----------
Run the following commands to bootstrap your environment ::
git clone https://github.com/SpotlightKid/fmchallengewebapp
cd fmchallengewebapp
pip install -r requirements/dev.txt
cp env.example .env
Then edit `.env` to set the database URI and the mail configuration.
Once you have installed your DBMS, run the following to create your app's
database tables and perform the initial migration ::
flask db init
flask db migrate
flask db upgrade
Then start the flask development server:
flask run
Go to http://127.0.0.1:5000/ and you will (hopefully) see a pretty welcome
screen.
Deployment
----------
To deploy::
export FLASK_ENV=production
export FLASK_DEBUG=0
export DATABASE_URL=""
flask run # start the flask server
In your production environment, make sure the ``FLASK_DEBUG`` environment
variable is unset or is set to ``0``.
Shell
-----
To open the interactive shell, run ::
flask shell
By default, you will have access to the flask ``app``.
Running Tests
-------------
To run all tests, run ::
flask test
Migrations
----------
Whenever a database migration needs to be made. Run the following commands ::
flask db migrate
This will generate a new migration script. Then run ::
flask db upgrade
To apply the migration.
For a full migration command reference, run ``flask db --help``.