Shopiley / fullstack-user-management

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

moni-africa-backend-test

Project Structure

This project is a monolith application. You will find two folders namely:

  1. backend
  2. frontend

Setup

Backend

  • Fork this repository to have a copy of it in your own github account

  • Clone the forked repo to your PC, this gives you access to the repo locally

  • Install Python from https://www.python.org/downloads/ if you haven't

  • cd into the project folder

  • cd into the backend folder

  • Ensure a virtual environment has been created and activated by either using

    python -m venv venv # to create a virtualenv
    source venv/bin/activate # activate for linux
    venv\Scripts\activate # activate for windows
  • Install all dependencies

    pip install -r requirements.txt
  • Run the somman below to start the server

    uvicorn app:app --reload
  • Navigate to http://127.0.0.1:8000/docs to access the Swagger UI docs to test endpoints.

Frontend

  • Open any of the html files in /frontend
  • Ensure the server is running

About


Languages

Language:HTML 80.9%Language:SCSS 13.2%Language:CSS 5.3%Language:Python 0.4%Language:JavaScript 0.2%