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'
1 month ago
bin Add an example docker-compose config 8 months ago
doc BREAKING: switch to versioned API URI scheme 1 month ago
project_amber Bump v0.0.4 1 month ago
.dockerignore Make the app run with Docker 8 months ago
.drone.yml Update Drone config 1 month ago
.gitignore Add VSCode dev internals to gitignore 1 month ago
.pylintrc Stop pylint from complaining on code that is easy to read 1 month ago
Dockerfile Improve caching 1 month ago
LICENSE.txt Initial commit 8 months ago
Pipfile Remove Python version requirement from Pipfile 1 month ago
Pipfile.lock Fixup 46251d75c44cfe95c0fe2852ef86418ca1adbb9b 1 month ago
README.md Migrate to pipenv for dependency management 1 month ago
docker-compose.yml Add an example docker-compose config 8 months ago
requirements.txt Update dependencies 1 month ago
setup.cfg Update yapf settings to follow pylint config 1 month ago
setup.py Bump v0.0.4 1 month ago

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.