Skip to content

README.md

Latest commit

 

History

History
87 lines (74 loc) · 3.43 KB

README.md

File metadata and controls

87 lines (74 loc) · 3.43 KB

backend

Unit Tests for Endpoints

Table of Contents
  1. About
  2. Getting Started
  3. Feature Development Workflow
  4. Acknowledgments

About

This is the source code for the API service used by the Learning Journey Planning System by All-in-One. This service is built with FastAPI

Getting Started

  1. Clone repository on local (with GitHub GLI: gh repo clone learning-journey-planning-system/backend)
  2. Ensure MAMP/WAMP is on.
  3. Rename .env.example to .env. Configure the connection string in that file. (see DB Connection String Examples).
  4. Ensure you have pipenv installed.
  5. Run the following commands: (1) cd backend, (2) pipenv shell, (3) ./start_backend.sh.
  6. Access the API docucumentation on your Chrome Browser.
  7. Once you have finished using the API service, end the service.

DB Connection String Examples

General Format mysql+mysqlconnector://<username>:<password>@localhost:<port_no>/<database_name>
MacOS mysql+mysqlconnector://root:root@localhost:3306/G10T3_LJPS_DB
Windows mysql+mysqlconnector://root@localhost:3306/G10T3_LJPS_DB

Documentation

Swagger Documentation @http://localhost:8000/docs Redoc Documentation @http://localhost:8000/redoc

End Service

  1. Stop backend service: ctrl + C
  2. Exit pipenv shell: ctrl + D

Feature Development Workflow

  1. Create a new branch (git checkout -b feature/<jira-ticket-number>-<short description>)
  2. Develop feature
  3. Write unit tests (if needed)
  4. Commit your Changes (git commit -m 'Adds <feature-description>')
  5. Push to the Branch (git push origin feature/<jira-ticket-number>-<short description>)
  6. Open a Pull Request

References