The backend app of Project Amber, a task list app
選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。
Timur Demin b671c0ea59
Merge branch 'develop'
2週間前
bin Add an example docker-compose config 3ヶ月前
doc Add an example docker-compose config 3ヶ月前
project_amber Bypass auth middleware for CORS checks 2週間前
.dockerignore Make the app run with Docker 3ヶ月前
.drone.yml Update CI config 1ヶ月前
.gitignore Remove SQLite databases from Git 3ヶ月前
.pylintrc Make pylint aware that db.session is autogenerated 3ヶ月前
Dockerfile Add an example docker-compose config 3ヶ月前
LICENSE.txt Initial commit 3ヶ月前
README.md Update README 2週間前
docker-compose.yml Add an example docker-compose config 3ヶ月前
requirements.txt Add CORS support 2週間前
setup.cfg Initial commit 3ヶ月前
setup.py Add CORS support 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.

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.

Licenses

See LICENSE.txt.