RAlanWright / ShiftClock_FastAPI

Web App for managing shifts

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ShiftClock_FastAPI

The aim for this web app is to manage shifts for one or more users.

Backend

  • Using the Python FastAPI library for speed/performance.
  • Containerized using Docker for ease of setup.

Frontend

Using React 👍

What is this project supposed to do?

This uses a REST API to handle shift operations.

  • View all shifts
  • View single shift by id
  • Add a new shift
  • Edit a shift
  • Delete a shift

Backend Setup

  • docker-compose up -d --build
  • docker-compose up
  • View the API at localhost:8002/docs

image

API Documentation via Swagger UI:

image

Get-All-Shifts:

image

Create-Shift:

image image

Update-Shift-By-Id:

image

Delete-Shift-By-Id:

image image

Frontend Setup

  • cd frontend
  • yarn -- This should be the equivalent of yarn add or yarn install
  • yarn start

Below is an earlier iteration of the frontend:

image

More recent iteration:

image

Known Issues:

  • Current iteration of the frontend doesn't compile. I'm in the process of working through some bugs.
  • No shift constraints (view all shifts between start and end time, ordered by start time) are ready yet.
  • Created shifts can overlap for the same user.
  • User authentication isn't fully set up yet.

About

Web App for managing shifts


Languages

Language:JavaScript 71.0%Language:Python 24.7%Language:HTML 2.6%Language:Mako 0.7%Language:Dockerfile 0.6%Language:CSS 0.4%