trillium/massage

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Trillium Massage is a modern, responsive website for booking in-home massage therapy services in the Los Angeles Metro Area. The platform offers a seamless booking experience, integrated maps for service areas, customer reviews, and comprehensive admin tools for managing appointments and business operations.

Key features include:

• Online appointment booking with instant confirmation
• Interactive service area maps
• Customer review system
• Admin dashboard for business management
• Gmail calendar integration
• Mobile-responsive design
• Secure payment processing

The project aims to provide a professional, user-friendly experience for both clients and the massage therapist, streamlining the booking and management process.

(back to top)

Built With

This project is built with modern web technologies:

• - React framework for production
• - UI library
• - Type-safe JavaScript
• - Utility-first CSS framework
• - Open-source maps
• - Product analytics
• - State management
• - Testing framework

(back to top)

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

• Node.js (version 18 or higher)
• pnpm (preferred package manager)
• Git

Installation

1. Clone the repository

   git clone https://github.com/trillium/massage.git
   cd massage

2. Install dependencies

   pnpm install

3. Set up environment variables

   cp .env.example .env.local
   # Edit .env.local with your configuration

4. Start the development server

   pnpm dev

5. Open http://localhost:3000 in your browser

(back to top)

Usage

The website provides a complete booking system for massage services:

• For Clients: Browse services, check availability, book appointments, leave reviews
• For Admin: Manage bookings, view analytics, handle customer inquiries

Key pages:

• / - Homepage with service overview
• /book - Appointment booking
• /services - Service details and pricing
• /reviews - Customer testimonials
• /admin - Administrative dashboard

For detailed documentation, see the Features Doc

(back to top)

Roadmap

• Core booking system
• Admin dashboard
• Gmail calendar integration
• Customer reviews
• Interactive maps
• PII removal

See the open issues for a full list of proposed features and known issues.

(back to top)

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Development Guidelines

• Follow the code style guidelines in AGENTS.md
• Run tests before submitting: pnpm test
• Ensure linting passes: pnpm lint
• Use conventional commits

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Trillium Smith - trilliummassagela@gmail.com

Project Link: https://github.com/trillium/massage
Live Site: https://trilliummassage.la/

(back to top)

Acknowledgments

• Next.js - The React framework used
• Tailwind CSS - For styling
• MapLibre - Open-source mapping
• PostHog - Analytics platform
• Best README Template - Template inspiration

(back to top)

/Users/trilliumsmith/code/massage/massage/docs/FEATURES.md