Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 1.34 KB

TUTORIAL.md

File metadata and controls

29 lines (20 loc) · 1.34 KB
Raw

vlecture Backend Documentation

Instructions

How to install and use the project (for the first time)

  1. Clone this repository with the command git clone https://github.com/jeremyalv/vlecture-api.git
  2. Make sure to enter the directory using cd vlecture-api
  3. Create a virtual environment using python -m venv env
  4. Run the virtual environment using source env/bin/activate for Mac and env\Scripts\activate.bat for Windows
  5. Install the required modules with pip install -r requirements.txt
  6. Run the app using make dev or .\build.bat

How to run (if you have already installed)

  1. Make sure get in the vlecture-api directory using cd vlecture-api
  2. Run your virtual environment using source env/bin/activate for Mac and env\Scripts\activate.bat for Windows
  3. Keep your project up-to-date by installing the newest modules using pip install -r requirements.txt
  4. Run the app using make dev or .\build.bat

Running Docker container

  1. Build Docker image: docker build -t vlecture-api .
  2. Run image on container port 8080: docker run -p 8080:8080 vlecture-api

Running Tests in Standardized Virtual Environments using tox

  1. Swap the environment variable into test environment (bash scripts/swap-env.sh test)
  2. Run tox and you'll see that pytest will automatically collect and run all your tests!