BoardRoom

This is the Frontend server for BoardRoom Application.

Table of Contents

• BoardRoom(#BoardRoom)
  • Table of Contents
  • About the Project
  • Getting Started
    • Prerequisites
    • Installation
    • Roadmap
  • Usage
  • Contributing
  • License
  • Contact

About the Project

The BoardRoom is a user-friendly platform that helps students find accommodation near their universities. The students can use BoardRoom to browse and select a wide range of houses that are tailored to their preferences and budget. BoardRoom provides students with detailed information, photos, and user reviews to help students find their perfect accommodations during their school year. BoardRoom aims to simplify the way students find their temporary accommodation during their school year.

Getting Started

Prerequisites

🚀 Frontend:

• ReactJS
• Vite with React template
• Tailwind CSS
• Alpine.js
• Material UI

🔙 Backend:

• NodeJS
• Express

🛢️ Database:

• PostgreSQL

Roadmap

• Registration and Authentication

  • Users must register with the system, providing required information.
  • User types include students or renters.
  • Password must be 8 to 15 characters.
  • Users can log in with username/email and password.

• Accommodation Search

  • Users can use a search bar to find preferred houses, locations, or buildings.

• Accommodation Categories

  • Users can choose from categories like boarding houses, apartments, or condos.

• Sorting and Filtering

  • Users can sort accommodations by price and set a budget range.
  • Sorting by ratings with options like more than 5 stars, 4 stars, etc.
  • Users can leave ratings and comments.

• Preference Filtering

  • Users can filter preferences based on property type, rooms, bathrooms, roommates, etc.

• Interactive Map

  • Users can visually assess the area of accommodations.

• Property Listing

  • Users can rent out properties by providing details and identity verification.

• Property Details

  • Users can view property details, features, rental cost, FAQs, distance to schools, and an interactive map.

• Owner Information

  • Users can view property owners' details, reviews, response rate, short description, and contact information.

Installation

[Provide step-by-step instructions on how to install your project. You can use code blocks for command-line instructions.]

# Example installation command
npm install  #this is to install all the necessary dependencies used for this application
#after its installed you can run the backend with this command
npm run dev