Salon Rium Coiffure

A hair salon app with AI virtual hairstyle
Explore the docs »

View Demo · Report Bug · Request Feature

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

🌟 Welcome to Salon Rium Coiffure - Your Ultimate Hair Care Destination! 💇‍♀️

• Experience luxury and convenience like never before with our state-of-the-art online platform, designed to revolutionize your salon experience! Owned by the dynamic duo Marie and Daniel in Montreal, Salon Rium Coiffure is here to redefine beauty and style.

📱 Seamless Booking Experience:

• Book your hair services effortlessly with our user-friendly online booking system. No more waiting on the phone or standing in line – your dream hairstyle is just a few clicks away!

📅 Appointment Management Made Easy:

• Say goodbye to scheduling hassles! Manage your appointments seamlessly, with options to reschedule or cancel at your convenience. Receive email and text notifications to stay updated every step of the way.

💇‍♂️ Tailored Services Just for You:

• Explore our extensive catalogue of hair services, with customizable options to suit your unique needs. From cuts to colors, we've got everything you need to look and feel your best!

💳 Secure Payment System:

• Enjoy peace of mind with our secure payment and deposit system. Whether you prefer PayPal or credit/debit card, your transactions are always safe and secure.

📅 Sync with Your Schedule:

• Sync your appointments effortlessly with your favorite calendar apps like Google Calendar. Stay organized and never miss a beat with Salon Rium Coiffure!

💌 Stay Informed with Notifications:

• Receive timely email and text notifications for appointment reminders and updates. We'll make sure you never miss a beat!

💬 24/7 Customer Service Support:

• Need assistance? Our friendly chatbot is here to help! Get quick answers to your questions and enjoy a seamless customer service experience.

💫 Discover Your Perfect Look:

• Try on different hairstyles virtually with our AI Virtual Hairstyle feature. Explore endless possibilities and find your perfect look from the comfort of your home!

📈 Unlock Salon Insights:

• For our valued salon partners, gain access to our analytics dashboard for valuable insights and performance tracking. Salon management has never been easier!

Ready to elevate your hair care routine? Join Salon Rium Coiffure today and experience the future of beauty! 💖 #SalonRiumCoiffure #HairCareRevolution #BookNow

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• node
  • https://nodejs.org/en
• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/junseo-yang/salon-rium-coiffure.git

2. Install NPM packages

   npm install

3. Copy the .env.example file with the name .env.

   cp .env.exmaple .env

4. Setup Environment Variables
   1. DATABASE_URL: Refer to https://www.mongodb.com/
   2. GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET: Refer to https://console.cloud.google.com/
   3. NEXTAUTH_URL: https://localhost:3000
   4. AI_LAB_TOOLS_API_KEY: Refer to https://www.ailabtools.com/
   5. SMTP_EMAIL and SMTP_PASSWORD: Refer to the instruction on https://www.gmass.co/blog/gmail-smtp/
   6. ADMIN_EMAIL: Provide your admin email. (e.g., [email protected])
   7. TWILIO_ACCOUNT_SID, TWILIO_AUTH_TOKEN, and TWILIO_PHONE_NUMBER: Refer to https://console.twilio.com/
5. Create Database

   npx prisma db push

Run Application Locally

1. Run the Application

   npm run dev

2. Open http://localhost:3000 with your browser

(back to top)

Roadmap

• Login
• Service Management
• Service/Designer Catalogue
• Appointment Management
• Staff Management
• Break Management
• Google Calendar Sync
• Email/Text Message Notification System
• Pop-Up Management
• Salon Analytics/Management
• AI Virtual Hairstyle
• Deposit/Payment System
• Chatbot for Customer Service

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

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

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

(back to top)

Contact

Junseo Yang

• 💼 LinkedIn: https://linkedin.com/in/junseo-yang
• 🎒 Website: https://junseo-yang.github.io
• 📫 [email protected]

Jisang Kim

• 💼 LinkedIn: https://www.linkedin.com/in/jisang-kim/
• 🎒 Website: https://groundkim.notion.site/Jisang-Kim-3fb2f6ea688841508ee5382633adfd55
• 📫 [email protected]

Yingqi Xu

• 💼 LinkedIn: https://www.linkedin.com/in/yingqi-xu/
• 🎒 Website: https://github.com/Yxu6894
• 📫 [email protected]

Project Link: https://github.com/junseo-yang/salon-rium-coiffure

(back to top)