🏠 LocaDwell

📝 Description

Full stack web application that allows users to book rooms in hotels and leave reviews about their experience. The application is built using the Django REST Framework and Next.js.

NOTE: This project is still in development. Frontend is not yet implemented.

💻 Technology

Technology	Use
Python	Main backend programming language
Django	Web framework
Django REST Framework	Toolkit for building Web APIs
SQLite3	Database
SimpleJWT	Authentication
TypeScript	Main frontend programming language
Next.js	Frontend framework
React.js	JavaScript library
Tailwind CSS	CSS framework
Shadcn	UI components
Redux Toolkit, RTK Query	State management, data fetching

🎁 Features

See server/README.md for a list of features.

API Documentation

See server/README.md for API documentation.

🚀 Getting Started

🛠️ Installation

1. Clone the repository:

   git clone https://github.com/ShokhrukhbekYuldoshev/locadwell

2. Navigate to the locadwell directory:

   cd locadwell

3. Backend:

   1. **Navigate to the `server` directory:**
   
       ```bash
       cd server
       ```
   
   2. **Install the dependencies:**
   
       ```bash
       pip install -r requirements.txt
       ```
   
   3. **Run the migrations:**
   
       ```bash
       python manage.py migrate
       ```
   
   4. **Create a virtual environment:**
   
       ```bash
       python -m venv .venv
       ```
   
   5. **Activate the virtual environment:**
   
       For Linux/MacOS:
   
       ```bash
       source .venv/bin/activate
       ```
   
       For Windows:
   
       ```bash
       .venv\Scripts\activate
       ```
   
   6. **Install the dependencies:**
   
       ```bash
       pip install -r requirements.txt
       ```
   
   7. **Run the server:**
   
       ```bash
       python manage.py runserver
       ```
   

4. Frontend:

   1. **Navigate to the `client` directory:**
   
       ```bash
       cd client
       ```
   
   2. **Install the dependencies:**
   
       ```bash
       npm install
       ```
   
   3. **Run the development server:**
   
       ```bash
       npm run dev
       ```
   

📷 Screenshots

Screenshots will be added soon.

🤝 Contributing

Contributions are welcome! Please feel free to submit any issues or pull requests.

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.