Skip to content

Latest commit

 

History

History
102 lines (67 loc) · 3.18 KB

README.md

File metadata and controls

102 lines (67 loc) · 3.18 KB

Serenity Haven App

serenity-haven.netlify.app

Description

Serenity Haven is a full-stack application for hotels where staff can manage their bookings, cabins, settings, users and view the dashboard with current sales, arrivals, departures and more statistics. App has been built using: Supabase, Vite, React.js, React Query, React Hook Form, React Router, and Styled Components while being optimized for desktop use but with full responsiveness up to 280px width.

Features:

  • Authentication & Authorization using Supabase feature and ProtectedRoute component.
  • Home Dashboard: Quick overview of today's arrivals and departures, current bookings, sales, check-ins, occupancy rate, and some graphs.
  • Booking Management: Review all bookings, remove or update them, as well as review details of a specific booking.
  • Cabin Administration: Add, remove, update, and duplicate cabins associated with the hotel.
  • User Management: Add new staff users to the app.
  • System Settings: Customize default system settings such as minimum and maximum booking nights, maximum guests, and breakfast prices.
  • Sample Data Loading: Simplify the setup process by loading sample data, including bookings, cabins, guests, and more.
  • Account Updates: Personalize your account by updating details such as name, password, and adding a custom avatar.
  • Light & Dark Mode: Choose your theme with the dark/light mode toggle button.

Login Information for Guests

Feel free to explore Serenity Haven using the following login credentials:

Table of Contents

Getting Started

To get this project up and running on your local machine, follow these steps:

Prerequisites

Make sure you have the following software installed on your system:

  • Node.js
  • npm (Node Package Manager)

Installation

  1. Clone the repository:
git clone https://github.com/adrian-prajsnar/serenity-haven.git
  1. Navigate to the project folder:
cd your-project
  1. Install the project dependencies:
npm install

Usage

  1. To run the project:
npm run dev
  1. To build the project:
npm run build
  1. To check for ESLint errors:
npm run lint

Contributing

I welcome contributions from the community to enhance and improve this project. To contribute, please follow these steps:

  1. Fork the project repository.
  2. Create a new branch for your feature or bug fix: git checkout -b feature/your-feature-name.
  3. Make your changes and commit them with clear, descriptive messages.
  4. Push your branch to your fork: git push origin feature/your-feature-name.
  5. Submit a pull request to the main repository, explaining the purpose and changes of your contribution.

I appreciate your contributions and will review and merge them as appropriate. Let's make this project better together!

License

MIT License