The backend app of Project Amber, a task list app
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Timur Demin b5cb76baa0
Merge branch 'develop'
пре 2 месеци
bin Add an example docker-compose config пре 9 месеци
doc BREAKING: switch to versioned API URI scheme пре 3 месеци
project_amber Bump v0.0.4 пре 2 месеци
.dockerignore Make the app run with Docker пре 9 месеци
.drone.yml Update Drone config пре 2 месеци
.gitignore Add VSCode dev internals to gitignore пре 3 месеци
.pylintrc Stop pylint from complaining on code that is easy to read пре 3 месеци
Dockerfile Improve caching пре 3 месеци
LICENSE.txt Initial commit пре 10 месеци
Pipfile Remove Python version requirement from Pipfile пре 2 месеци
Pipfile.lock Fixup 46251d75c44cfe95c0fe2852ef86418ca1adbb9b пре 2 месеци
README.md Migrate to pipenv for dependency management пре 3 месеци
docker-compose.yml Add an example docker-compose config пре 9 месеци
requirements.txt Update dependencies пре 3 месеци
setup.cfg Update yapf settings to follow pylint config пре 2 месеци
setup.py Bump v0.0.4 пре 2 месеци

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.