https://github.com/sergioisidoro/acropolis

https://github.com/sergioisidoro/acropolis

Last synced: 23 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/sergioisidoro/acropolis
• Owner: sergioisidoro
• License: bsd-3-clause
• Created: 2016-11-26T22:58:52.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2016-11-27T00:57:06.000Z (about 8 years ago)
• Last Synced: 2024-10-05T20:41:36.255Z (3 months ago)
• Language: JavaScript
• Size: 1.11 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
===============================

Acropolis

===============================

An agora manager

Quickstart

----------

First, set your app's secret key as an environment variable. For example,

add the following to ``.bashrc`` or ``.bash_profile``.

.. code-block:: bash

    export ACROPOLIS_SECRET='something-really-secret'

Before running shell commands, set the ``FLASK_APP`` and ``FLASK_DEBUG``

environment variables ::

    export FLASK_APP=/path/to/autoapp.py

    export FLASK_DEBUG=1

Then run the following commands to bootstrap your environment ::

    git clone https://github.com/sergioisidoro/acropolis

    cd acropolis

    pip install -r requirements/dev.txt

    bower install

    flask run

You will see a pretty welcome screen.

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

    flask run

Deployment

----------

In your production environment, make sure the ``FLASK_DEBUG`` environment

variable is unset or is set to ``0``, so that ``ProdConfig`` is used.

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``.