Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/y-broad/workschedule/llms.txt

Use this file to discover all available pages before exploring further.

Work Schedule Organizer is a React and Vite application with no backend dependencies. Getting it running locally takes one clone, one install, and one command. Follow the steps below to go from zero to a live schedule view in your browser.
1

Prerequisites

Make sure you have Node.js 18 or later installed. You can check your version by running:
node --version
If you need to install or upgrade Node.js, download the LTS release from nodejs.org.
2

Clone the repository

Clone the project from GitHub to your local machine:
git clone https://github.com/y-broad/workschedule
cd workschedule
3

Install dependencies

Install the project’s npm packages:
npm install
This installs React 19, Vite, and the ESLint dev dependencies listed in package.json.
4

Start the dev server

Start the Vite development server:
npm run dev
Vite will compile the project and print the local URL where the app is running.
5

Open the app

Open http://localhost:5173 in your browser.You should see the Employee Work Schedule Organizer heading, the employee list sorted alphabetically, a workday filter bar, and an Add Employee button in the top section.

​
What you see on first load

When the app loads, it fetches public/employees.json and renders the full employee list sorted alphabetically. The initial dataset includes 12 employees — Alice through Susan — each with contact details and a Monday–Friday work schedule shown as checkboxes.
  • The filter bar at the top lets you check one or more days to narrow the list.
  • The Add Employee button opens an inline form where you can enter contact details and select workdays. The new employee is inserted into the sorted list immediately.
To change the employees that appear on first load, edit public/employees.json. Each record requires id, name, phone, email, and a workdays object with boolean values for monday through friday. See the employee data format page for the full schema.

​
Available scripts

These scripts are defined in package.json and run with npm run <script>:
ScriptCommandDescription
devnpm run devStart the Vite dev server with hot module reload.
buildnpm run buildBundle the app for production into dist/.
previewnpm run previewServe the production build locally for inspection.
lintnpm run lintRun ESLint across all source files.

Build docs developers (and LLMs) love

Get started for freeTalk to us