HiveHaven

Welcome to HiveHaven, your trusted platform for connecting international students with reliable accommodations across the US.

Table of contents:

• Introduction
• Features
• Technologies Used
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Project Structure
• Contributing
• License
• Contact

Introduction

HiveHaven is a platform that connects international students with reliable accommodations across the US. The platform is designed to help students find the best accommodation that suits their needs and preferences. The platform uses machine learning to recommend the best accommodation based on the student's preferences and budget. The platform also provides a platform for students to connect with other students and landlords to find the best accommodation.

Features

• Accommodation Search: Students can search for accommodations based on their preferences and budget.
• Accommodation Recommendation: The platform uses machine learning to recommend the best accommodation based on the student's preferences and budget.
• Accommodation Listing: Landlords can list their accommodations on the platform.
• Student Connection: Students can connect with other students to find the best accommodation.
• Landlord Connection: Landlords can connect with students to find the best accommodation.
• Chat: Students and landlords can chat with each other to discuss the accommodation.
• Notifications: Students and landlords receive notifications for new messages and accommodation recommendations.
• Reviews: Students and landlords can leave reviews for each other.
• Ratings: Students and landlords can rate each other.
• Payments: Students can make payments for accommodations through the platform.
• Booking: Students can book accommodations through the platform.
• Profile: Students and landlords can create profiles on the platform.
• Verification: Students and landlords can verify their profiles.
• Support: Students and landlords can contact support for any issues.
• Feedback: Students and landlords can provide feedback on the platform.
• Privacy: The platform ensures the privacy of students and landlords.

Technologies Used

• ReactJS
• TailwindCSS
• JavaScript
• Node.js
• Express.js
• MySQL
• Tensorflow
• Figma

Getting Started

To get started with the project, follow the instructions below.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v14 or later)
• npm (v6 or later) or yarn (v1.22 or later)

Installation

1. Clone the repository:

git clone https://github.com/pathak-ashutosh/students-accomodation.git
cd students-accomodation

2. Install the dependencies:

npm install

3. Create a .env file in the root directory and add the following environment variables:

REACT_APP_API_URL=http://localhost:5000

Usage

To use the application, follow the instructions below.

1. Start the server:

npm start

2. Open the browser and go to http://localhost:3000.

Project Structure

The project structure is as follows:

students-accomodation/
├── backend/
│   ├── config/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   ├── app.js
│   ├── server.js
│   ├── .env
│   ├── package.json
├── frontend/
│   ├── public/
|   |   ├── index.html
|   |   ├── ...
│   ├── src/
│   │   ├── assets/
│   │   ├── components/
│   │   ├── pages/
│   │   ├── sections/
│   │   ├── App.jsx
│   │   ├── index.js
│   │   ├── ...
│   ├── .env
│   ├── package.json
├── .gitignore
├── LICENSE
├── README.md

Contributing

Contributions are welcome! To contribute to the project, follow the steps below:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature).
3. Make the necessary changes and commit them (git commit -am 'Add new feature').
4. Push the changes to the branch (git push origin feature/your-feature).
5. Create a new pull request.
6. Get the pull request reviewed and approved.
7. Repeat the process for other features.

License

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

Contact

If you have any questions, feel free to reach out to me at X or email me at ashutoshpathak@thenumbercrunch.com