Skip to content

Latest commit

 

History

History
116 lines (104 loc) · 2.71 KB

README.md

File metadata and controls

116 lines (104 loc) · 2.71 KB

Take A Breath - Hotel Booking App

Welcome to the Take A Breath app! This application is designed to help users find and book hotels effortlessly, providing a seamless experience for planning their perfect getaway. Built with ReactJS, NodeJS, and MongoDB, Take A Breath aims to offer a user-friendly interface and robust backend functionality.

🛠️ Tech Stack

Frontend:

  • ReactJS: Component-based UI development.
  • Redux: State management.
  • TailwindCSS and SCSS: Styling.
  • Ant Design (Antd): UI components.

Backend:

  • NodeJS: JavaScript runtime.
  • ExpressJS: Backend framework.
  • MongoDB: Database.
  • JWT: Authentication and Authorization.

Deployment:

  • Vercel: For deploying the application.
  • Link: TakeABreath

🔗 Live Demo

TakeABreath - Live Demo

🚀 How to Run the Project

Without Installation (Using Docker)

  1. Navigate to the project root directory: 
    cd root
  2. Run the following command: 
    docker-compose up
  3. Open your browser and visit http://localhost:3000/.

With Installation

  1. Clone the repository: 
    git clone https://github.com/thy015/takeabreath.git
  2. Navigate to the project client directory: 
    cd client
    Install the dependencies: 
    npm install
    pnpm install
  3. Navigate to the project server directory: 
    cd server
    Install the dependencies: 
    npm install
    pnpm install
  4. Start the client and server: client 
    npm start
    server 
    npm run dev

📂 Project Structure

takeabreath/
├── client/
│   ├── public/
│   ├── src/
│   │   ├── hooks/
│   │   ├── components/
│   │   ├── pages/
│   │   ├── styles/
│   │   ├── localData/
│   │   ├── partials/
│   │   ├── routers/
│   │   └── ...
│   ├── .env
│   ├── package.json
│   ├── pnpm-lock.yaml
│   └── ...
├── server/
│   ├── config/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   ├── .env
│   ├── package.json
│   ├── pnpm-lock.yaml
│   ├── server.ts
│   └── ...
├── docker-compose.yml
├── README.md
└── ...

💡 Additional Notes

Ensure you have Docker installed if you want to run the project without manual installation.
For any issues or inquiries, please create an issue.

Reach me for any queries or suggestions. I am always open🌟

pattern_takeabreath