Skip to content

geolunalg/shift-tea

Repository files navigation

test badge

Shift-Tea

Description

Shift-Tea is a web-based staff scheduling application that allows managers to create monthly schedules and gives staff easy online access to view their shifts. Built to replace error-prone spreadsheets with a reliable, user-friendly solution.

Motivation

This project was inspired by a real problem I witnessed: a Director of Nurses struggling with fragile Excel formulas that would corrupt their entire staff scheduling spreadsheet. This highlighted a widespread issue many managers face - spreadsheet-based scheduling is error-prone, and when formulas break, managers waste hours recreating schedules while staff remain uncertain about their shifts. Shift-Tea eliminates this problem by providing a reliable, web-based alternative that abstracts complex scheduling logic into a user-friendly application.

Quick Start with Docker

For the fastest way to get started, run the docker-compose file located in the project's root directory with the following command:

docker compose up

This command will launch both the server and the PostgreSQL database in Docker containers.

Once the containers are running, you can view the API documentation at http://localhost:8080/api/v1/docs.

Manual Setup

For a more involved setup, follow the steps below.

Prerequisites & Setup

  1. Install NVM
  2. Install Node.js
  3. Setup PostgreSQL
  4. Configure Environment Variables

Running the Application

  1. Clone this repository
  2. Install dependencies: npm install
  3. Run database migrations: npm run migrate
  4. Start the server: npm start
  5. Visit http://localhost:3000

Usage

For Managers:

  • Create monthly schedules by assigning staff to shifts
  • Set shift start and end times
  • View schedule overview and coverage

For Staff:

  • View assigned shifts for the current month
  • Check shift times and dates

Contributing

Contributions welcome! Please open an issue first to discuss any major changes and create a pull request for review.

About

Used for creating a staff schedule for a month in the year

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages