README.md

Notes

Notes is a sample API for managing todo lists, notes, and such. It's meant to be a showcase of my own developer skills, and serves no other purpose.

Configuration

Notes uses Flask's instance folder for storing configuration files. Said files can be written in either JSON or YAML and passed to Flask at runtime.

Example:

# OpenAPI configuration values, see https://apiflask.com/configuration/#openapi-fields
CONTACT:
  name: contact
  email: [email protected]
LICENSE:
  name: MPL 2.0
  url: https://www.mozilla.org/en-US/MPL/2.0/
DESCRIPTION: |
  A description of the API.
SERVERS:
  - name: Development Server
    url: http://localhost:5000

# Flask app configuration values, see https://flask.palletsprojects.com/en/2.0.x/config/#builtin-configuration-values
SECRET_KEY: secret

Following environment variables need to be set:

• MONGO_URL specifies the URL at which the MongoDB database for the API can be accessed;
• FLASK_ENV specifies the environment for Flask, and can be set to either development or production;
• FLASK_APP specifies how to load the app and needs to be set to notes:create_app('<config_file_name>').

Usage

Notes doesn't need to (but can) be installed, and can be launched as any other Flask application:

flask run

License

Notes is licensed under Mozilla Public License 2.0.