Skip to content

Getting‐Started

Jump to bottom
Prashant Maurya edited this page Jul 19, 2026 · 1 revision

Getting Started

This guide walks you through setting up Nestify locally for development.

Prerequisites

Make sure you have the following installed:

  • Java 21
  • Maven
  • MySQL (or a compatible RDBMS)
  • Node.js + npm (for the React frontend)
  • Eclipse / IntelliJ (recommended IDEs)

1. Clone the Repository

bash
git clone https://github.com/prashantpiyush1111/Nestify-PG-Management-System.git
cd Nestify-PG-Management-System

2. Backend Setup (Spring Boot)

  1. Open the project in Eclipse or IntelliJ.
  2. Configure your database in src/main/resources/application.properties:
properties
   spring.datasource.url=jdbc:mysql://localhost:3306/nestify_db
   spring.datasource.username=root
   spring.datasource.password=yourpassword
  1. Create the database in MySQL:
sql
   CREATE DATABASE nestify_db;
  1. Run the application (as a Spring Boot App). It starts on port 8080.

3. Frontend Setup (React + Vite)

bash
cd frontend
npm install
npm run dev

The frontend runs on http://localhost:5173 and talks to the backend on port 8080.

4. Sample Login Credentials

Role | Username | Password -- | -- | -- Admin | admin | admin123 Tenant | tenant1 | tenant123

⚠️ Change these default credentials before deploying to production.

Next Steps

Getting Started

This guide walks you through setting up Nestify locally for development.

Prerequisites

Make sure you have the following installed:

Java 21 Maven MySQL (or a compatible RDBMS) Node.js + npm (for the React frontend) Eclipse / IntelliJ (recommended IDEs)

  1. Clone the Repository

bashgit clone https://github.com/prashantpiyush1111/Nestify-PG-Management-System.git cd Nestify-PG-Management-System

  1. Backend Setup (Spring Boot)

Open the project in Eclipse or IntelliJ. Configure your database in src/main/resources/application.properties:

properties spring.datasource.url=jdbc:mysql://localhost:3306/nestify_db spring.datasource.username=root spring.datasource.password=yourpassword

Create the database in MySQL:

sql CREATE DATABASE nestify_db;

Run the application (as a Spring Boot App). It starts on port 8080.

  1. Frontend Setup (React + Vite)

bashcd frontend npm install npm run dev

The frontend runs on http://localhost:5173/ and talks to the backend on port 8080.

  1. Sample Login Credentials

RoleUsernamePasswordAdminadminadmin123Tenanttenant1tenant123

⚠️ Change these default credentials before deploying to production.

Next Steps

Read the Architecture page to understand the system design. Check Features to see what's implemented. See API Reference for backend endpoints.

Clone this wiki locally