/domain-manager-api

Flask API for Domain Manager

Primary LanguagePythonCreative Commons Zero v1.0 UniversalCC0-1.0

Domain Manager

Domain Categorization and Management

Required

Get the right flavor of Docker for your OS...

Note: The recommended requirement for deployment of this project is 4 GB RAM. For Docker for Mac, this can be set by following these steps:

Open Docker > Preferences > Advanced tab, then set memory to 4.0 GiB

Setup project locally

  1. Copy your env vars:

    • cp etc/env.dist .env

  2. Build containers:

    • make build

  3. Run Containers

    • make up

  4. Run flask logs in the terminal

    • make logs

  5. Application running at:

    • localhost:5000

Other commands

Run live flask logs in the terminal

  • make logs

Stop containers

  • make stop

Remove containers

  • make down

Shell into container

  • make shell

Run pre-commit:

  • pre-commit run --all-files

Count lines of code

  • make loc

API Documentation

  • To access the api documentation to this project, visit:
    • localhost:5000

Contributing

We welcome contributions! Please see here for details.

License

This project is in the worldwide public domain.

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.