Skip to content

CuBoulder/atlas

Repository files navigation

Atlas

Atlas is a RESTful API that interacts with servers to deploy and maintain Web Express at University of Colorado Boulder.

Features

  • Chronological tasks run to keep a small number of instances available for assignment to end users.
  • POST to create additional instances on demand.
  • Available instances are replaced every night.
  • All items are versioned.
  • Backups and restore to new instance.

API

  • Prefers to receive JSON encoded POST request.
  • CRUD Web Express instances

Local setup

  • Create and activate virtual environment

    virtualenv .venv
    source .venv/bin/activate
  • Install requirements

    pip install -r requirements.txt
  • Install MongoDB - Homebrew

    brew tap mongodb/brew
    brew install mongodb-community@4.2
    # Run as a Homebrew service
    brew services start mongodb-community@4.2
  • Create config files and update with your information

    cp atlas/config_local.py.example atlas/config_local.py
    cp atlas/config_servers.py.example atlas/config_servers.py
  • Start Atlas

    FLASK_APP=run.py flask run
  • Import sample database

    mongorestore [path/to/dump/location]