The backend app of Project Amber, a task list app
Non puoi selezionare più di 25 argomenti Gli argomenti devono iniziare con una lettera o un numero, possono includere trattini ('-') e possono essere lunghi fino a 35 caratteri.
 
 
 
Timur Demin dd4906833a
Merge branch 'develop' at v0.0.5
2 mesi fa
bin Add an example docker-compose config 1 anno fa
doc BREAKING: switch to versioned API URI scheme 6 mesi fa
project_amber Bump v0.0.5 2 mesi fa
.dockerignore Make the app run with Docker 1 anno fa
.drone.yml Remove excessive pip install 2 mesi fa
.gitignore Add VSCode dev internals to gitignore 6 mesi fa
.pylintrc Stop pylint from complaining on code that is easy to read 6 mesi fa
Dockerfile Bump Python version in Dockerfile 2 mesi fa
LICENSE.txt Initial commit 1 anno fa
Pipfile Add mypy config 2 mesi fa
Pipfile.lock Add mypy config 2 mesi fa
README.md Migrate to pipenv for dependency management 6 mesi fa
docker-compose.yml Add an example docker-compose config 1 anno fa
requirements.txt Add mypy config 2 mesi fa
setup.cfg Add mypy config 2 mesi fa
setup.py Bump v0.0.5 2 mesi fa

README.md

Amber Backend

This is the backend app of Project Amber, a task list app.

This is a basic Flask/SQLAlchemy app that takes care of syncing tasks between devices.

Configuration

The config file is a JSON file that is loaded from either ./config.json or /etc/amber.json, whichever is found first.

Example config:

{
    "database": "sqlite:///file.db", // SQLAlchemy database URI
    // see https://docs.sqlalchemy.org/en/13/core/engines.html#database-urls
    "allow_signup": false, // whether to allow /api/signup or not
    "loglevel": 0, // 0: errors, 1: warnings, 2: info
    "domain": "https://your.domain.tld" // full domain with HTTPS, needed for CORS
}

If there are environment variables AMBER_DATABASE / AMBER_ALLOW_SIGNUP / AMBER_LOGLEVEL / AMBER_DOMAIN set, the program will respect them and use over the values provided with the config file.

Dependencies

This app directly depends on flask, flask-sqlalchemy, flask-cors, and bcrypt.

requirements.txt is left only so that pipenv is not needed while building the app in Docker. Please use pipenv in development.

Running in Docker

The Dockerfile included with the project assumes that:

  1. You’re going to use either PostgreSQL or SQLite.
  2. You’re going to run it behind a reverse proxy such as nginx (and running the app without a reverse proxy won’t work because of the current uwsgi configuration).

If you have to/prefer to use MariaDB, etc, you’ll have to add the necessary Python packages to the Docker image by hand. See SQLAlchemy docs for details.

Licenses

See LICENSE.txt.