Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shohan-pherones/mimosa-server
Mimosa is your premier destination for beauty and relaxation. Our parlor and spa offer a range of luxurious beauty packages and spa treatments to help you look and feel your best. Whether you're looking to pamper yourself with a rejuvenating spa day or enhance your beauty with our expert services, Mimosa has you covered.
https://github.com/shohan-pherones/mimosa-server
beauty beauty-salon express husky mongodb mongoose mvc nodejs oop typescript
Last synced: 21 days ago
JSON representation
Mimosa is your premier destination for beauty and relaxation. Our parlor and spa offer a range of luxurious beauty packages and spa treatments to help you look and feel your best. Whether you're looking to pamper yourself with a rejuvenating spa day or enhance your beauty with our expert services, Mimosa has you covered.
- Host: GitHub
- URL: https://github.com/shohan-pherones/mimosa-server
- Owner: shohan-pherones
- Created: 2023-09-13T17:14:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-19T07:41:27.000Z (about 1 year ago)
- Last Synced: 2023-11-19T18:35:51.798Z (about 1 year ago)
- Topics: beauty, beauty-salon, express, husky, mongodb, mongoose, mvc, nodejs, oop, typescript
- Language: TypeScript
- Homepage: https://mimosa-server.vercel.app
- Size: 101 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mimosa Beauty Parlor and Spa
## Introduction
Mimosa is your premier destination for beauty and relaxation. Our parlor and spa offer a range of luxurious beauty packages and spa treatments to help you look and feel your best. Whether you're looking to pamper yourself with a rejuvenating spa day or enhance your beauty with our expert services, Mimosa has you covered.
## Features
1. Browse Beauty Packages: Users can explore a variety of beauty packages tailored to their needs.
2. Book Packages: Users can easily book their preferred beauty packages.
3. Manage Bookings: Users have the option to manage their booked packages.
4. Admin Control: Admins can manage both users and beauty packages effortlessly.
## Technologies
- Node.js
- Express.js
- MongoDB
- Mongoose
- TypeScript
- Docker
## Models
### User
| Field | Type |
| ----------- | ------------------ |
| Name | String |
| Email | String |
| Password | String |
| PhotoUrl | String |
| Address | String (Optional) |
| PhoneNumber | String (Optional) |
| Role | Enum [user, admin] |
| Bookings | Booking[] |
### BeautyPackage
| Field | Type |
| ----------- | ------------ |
| Title | String |
| Description | String |
| Category | String |
| Images | String[] |
| Price | Number |
| Specialists | Specialist[] |
| Bookings | Booking[] |
### Specialist
| Field | Type |
| -------------- | --------------- |
| Name | String |
| Designation | String |
| Bio | String |
| PhotoUrl | String |
| DateOfBirth | String |
| BeautyPackages | BeautyPackage[] |
### Booking
| Field | Type |
| ------------- | ---- |
| User | {} |
| BeautyPackage | {} |
## API Routes
| SL No. | HTTP Verb | Endpoint | Description | Permission |
| ------ | --------- | -------------------------------------- | ----------------------- | ---------- |
| 1 | POST | /api/auth/register | Register a user | All |
| 2 | POST | /api/auth/login | Login a user | All |
| 3 | GET | /api/users | Get all users | Admin |
| 4 | GET | /api/users/{userId} | Get an user | User/Admin |
| 5 | DELETE | /api/users/{userId} | Delete an user | User/Admin |
| 6 | PUT | /api/users/{userId} | Update an user | User/Admin |
| 7 | GET | /api/beauty_packages | Get all beauty packages | All |
| 8 | GET | /api/beauty_packages/{beautyPackageId} | Get a beauty package | All |
| 9 | POST | /api/beauty_packages | Create a beauty package | Admin |
| 10 | PUT | /api/beauty_packages/{beautyPackageId} | Update a beauty package | Admin |
| 11 | DELETE | /api/beauty_packages/{beautyPackageId} | Delete a beauty package | Admin |
| 12 | GET | /api/specialists | Get all specialists | All |
| 13 | GET | /api/specialists/{specialistId} | Get a specialist | All |
| 14 | POST | /api/specialists/{beautyPackageId} | Create a specialist | Admin |
| 15 | PUT | /api/specialists/{specialistId} | Update a specialist | Admin |
| 16 | DELETE | /api/specialists/{specialistId} | Delete a specialist | Admin |
| 17 | POST | /api/bookings/create/{beautyPackageId} | Create a booking | User |
| 18 | GET | /api/bookings | Get all bookings | Admin |
| 19 | DELETE | /api/bookings/{bookingId} | Delete a booking | User |
## Installation
1. Clone this repository.
2. Create an `.env` file with the following variables:
- `MONGO_URI` (Your MongoDB connection URI)
- `JWT_SECRET` (A secret key for JWT token generation)
3. Run `yarn` to install project dependencies.
4. Start the development server with `yarn dev`.
If you have Docker and Docker Compose installed on your machine, you can simply execute `docker-compose build` and `docker-compose up` to start the app. Additionally, to access the Docker image, you can visit [https://hub.docker.com/r/spectrashohan/mimosa-server](https://hub.docker.com/r/spectrashohan/mimosa-server).
## Conclusion
Mimosa Beauty Parlor and Spa is your one-stop destination for beauty and relaxation. Whether you're looking to unwind with our spa treatments or enhance your beauty with our expert services, Mimosa has everything you need. Book your beauty package today and experience the ultimate pampering.