Automator API

Server side for Class Website Automator. Automates creating the class website for NSS students.

Getting Started

1. Check the python version, python3 --version. If it is not 3.9.*, run the install script for your os:

   • Mac: /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/nashville-software-school/bangazon-llc/cohort-56/book-1-kennels/chapters/scripts/mac-installs.sh)"
   • WSL or Ubuntu: /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/nashville-software-school/bangazon-llc/cohort-56/book-1-kennels/chapters/scripts/wsl-ubuntu-installs.sh)"

2. Run the set up commands. This will set up the environment, database, and initial data.

   pipenv shell
   pipenv install --dev
   ./manage.py migrate
   ./manage.py loaddata programs cohorts themes

   3. .env file - instruction coming soon
   4. When opening vscode for the first time, there are 2 extension recommendations. Accept the extension installs when the pop up appears. These will make debugging and running tests easier.

Commands

• Run the server: ./manage.py runserver
• Run tests: ./manage.py test
• Run tests with coverage: pipenv run test
• Create a super user (for use with django admin): ./manage.py createsuperuser
• Lock the package requirements after adding packages: pipenv requirements > requirements.txt