https://github.com/exhuma/powonline

Tracker for PowWow 2017
https://github.com/exhuma/powonline

Last synced: 5 months ago
JSON representation

Tracker for PowWow 2017

• Host: GitHub
• URL: https://github.com/exhuma/powonline
• Owner: exhuma
• License: mit
• Created: 2017-05-26T15:00:15.000Z (about 9 years ago)
• Default Branch: develop
• Last Pushed: 2025-05-13T05:27:40.000Z (about 1 year ago)
• Last Synced: 2025-05-13T06:27:04.238Z (about 1 year ago)
• Language: Python
• Size: 1.46 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
.. >>> Shields >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

.. image:: https://travis-ci.org/exhuma/powonline.svg?branch=develop

    :target: https://travis-ci.org/exhuma/powonline

.. <<< Shields <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<

Pow

===

This repository contains an application to help out with a local event.

Required Environment Variables

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

POWONLINE_DSN

    The database DSN (f.ex.: ``postgresql://user:password@host/dbname``)

Development Setup (Recommended)

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

To ensure reproducible development environments, the project uses

"dev-containers" since March 2023.

Dev-Containers can be used standalone, or, via the VS-Code "Remote Development"

extension. The latter is well integrated and allows for seamless project setup.

All the required files are located in the ``.devcontainer`` folder in the

project root. This is picked up by VS-Code and you can simply select the

"Reopen in Container" option from the command pallette (normally also provided

via a small popup when the project is loaded).

Database Migrations

-------------------

The dev-container initialises everything automatically and no additional step

is needed.

During development, all ``alembic`` tasks can simply be executed from whithin

the ``database`` subfolder.

The production application container contains a separate entry-point

``/upgrade-db.bash`` to trigger the migrations. Simply execute it as follows

whenever needed::

    docker run \

        --rm \

        -e POWONLINE_DSN= \

        --entrypoint /upgrade-db.bash \

        

On k8s style deployments, this can be executed in init-containters for example.

Development Setup (legacy)

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

You need:

* `git `_

* `Python 3 `_ (On debian & derivatives you also need

  the package ``python3-venv``).

* `fabric `_

* `pip `_ (should be automatically available in

  Python 3 Virtual Environments).

Bootstrapping a development environment:

Once you have at least git and Python (including ``python-venv`` on debian)

installed, run the following commands::

    git clone https://github.com/exhuma/powonline

    cd powonline

    git checkout develop

    fab develop

After the above steps are run you should be able to run the backend using the

following command::

    $ fab run

Authentication

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

The frontent authenticates using an OAuth provider like Google or Facebook. If

a user does not exist yet it will be automatically created in the DB with

default (no) permissions. In order to make the application usable at least one

user needs the "admin" role.

This can be done on the CLI with the following command::

    flask grant-admin 

The permission can be revoked again using::

    flask revoke-admin 

Existing users can be listed with::

    flask list-users