Your favorite shift management application!
docs: update README to include color coding and password protection features
panteLxe0dde42bc1e7
diff --git a/README.md b/README.mdindex f80180b..e871d75 100644--- a/README.md+++ b/README.md@@ -1,6 +1,6 @@# BetterShift-A modern shift management application built with Next.js and SQLite. BetterShift helps you organize and manage work shifts across multiple calendars with customizable presets.+A modern shift management application built with Next.js and SQLite. BetterShift helps you organize and manage work shifts across multiple calendars with customizable presets, color coding, and password protection.## Features@@ -9,19 +9,10 @@ A modern shift management application built with Next.js and SQLite. BetterShift- π¨ **Color Coding**: Assign colors to calendars for better visualization- π **Shift Presets**: Create reusable shift templates for faster scheduling- ποΈ **Calendar View**: Interactive monthly calendar with week-based layout+- π **Password Protection**: Secure calendars with optional passwords- πΎ **SQLite Database**: Lightweight, file-based database with Drizzle ORM- π³ **Docker Support**: Easy deployment with Docker and Docker Compose-## Tech Stack--- **Framework**: [Next.js 16](https://nextjs.org/) with React 19-- **Database**: SQLite with [Drizzle ORM](https://orm.drizzle.team/)-- **Styling**: [Tailwind CSS 4](https://tailwindcss.com/)-- **UI Components**: [Radix UI](https://www.radix-ui.com/)-- **Date Handling**: [date-fns](https://date-fns.org/)-- **Icons**: [Lucide React](https://lucide.dev/)-- **TypeScript**: Full type safety-## Prerequisites- Node.js 20+ (for local development)@@ -110,67 +101,6 @@ npm run db:pushnpm run db:studio```-### Database Location--- **Development**: SQLite database file location depends on your configuration-- **Production/Docker**: `./data/sqlite.db` (persisted in the `data` volume)--## Project Structure--```-bettershift/-βββ app/ # Next.js app directory-β βββ api/ # API routes-β β βββ calendars/ # Calendar endpoints-β β βββ presets/ # Preset endpoints-β β βββ shifts/ # Shift endpoints-β βββ globals.css # Global styles-β βββ layout.tsx # Root layout-β βββ page.tsx # Home page-βββ components/ # React components-β βββ ui/ # Reusable UI components-β βββ calendar-*.tsx # Calendar components-β βββ preset-*.tsx # Preset components-β βββ shift-*.tsx # Shift components-βββ lib/ # Utility functions-β βββ db/ # Database configuration-β β βββ index.ts # Database client-β β βββ schema.ts # Drizzle schema-β βββ date-utils.ts # Date helper functions-β βββ types.ts # TypeScript types-β βββ utils.ts # General utilities-βββ data/ # SQLite database directory-βββ drizzle/ # Database migrations-βββ docker-compose.yml # Docker configuration-βββ Dockerfile # Docker image definition-```--## API Endpoints--### Calendars--- `GET /api/calendars` - List all calendars-- `POST /api/calendars` - Create a new calendar-- `GET /api/calendars/[id]` - Get calendar by ID-- `PUT /api/calendars/[id]` - Update calendar-- `DELETE /api/calendars/[id]` - Delete calendar--### Shifts--- `GET /api/shifts?calendarId=<id>&startDate=<date>&endDate=<date>` - List shifts-- `POST /api/shifts` - Create a new shift-- `GET /api/shifts/[id]` - Get shift by ID-- `PUT /api/shifts/[id]` - Update shift-- `DELETE /api/shifts/[id]` - Delete shift--### Presets--- `GET /api/presets?calendarId=<id>` - List presets-- `POST /api/presets` - Create a new preset-- `GET /api/presets/[id]` - Get preset by ID-- `PUT /api/presets/[id]` - Update preset-- `DELETE /api/presets/[id]` - Delete preset-## ContributingContributions are welcome! Please feel free to submit a Pull Request.