Skip to content

About

EasyPG is a mobile-first PG and rental discovery platform built with React Native and Expo, designed to simplify finding, listing, and managing paying guest accommodations.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Latest commit

Β 

History

42 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

EasyPG Logo EasyPG

A smarter way to discover and manage PGs, hostels, and mess accommodations.

EasyPG connects students and working professionals with suitable accommodations while giving property owners the tools they need to manage listings, inquiries, and booking requests.


πŸ“Œ Overview

Finding reliable accommodation can be time-consuming, especially for students and professionals moving to a new city.

EasyPG simplifies this process by providing a mobile-first platform where users can:

  • Discover PGs, hostels, and mess accommodations
  • Search by location and personal preferences
  • Compare rent, facilities, ratings, and availability
  • View listings on an interactive map
  • Save properties and contact owners directly
  • Submit visit and booking inquiries

Property owners can create and manage listings, update availability, upload property images, and respond to potential tenants through a dedicated host experience.


πŸ“± Screenshots

EasyPG home screen
Home
EasyPG map view
Map View
EasyPG property details screen
Property Details
EasyPG property inquiry form
Submit Inquiry

✨ Features & Functionality

πŸ” Property Discovery

Users can explore available accommodations based on their preferred city, budget, property type, and gender preference.

Key discovery features include:

  • Search for PGs, hostels, and mess accommodations
  • Filter listings by rent, location, gender, and property category
  • Browse nearby accommodations using location-based search
  • View available and trusted properties
  • Explore detailed property information before contacting an owner

πŸ—ΊοΈ Interactive Map Experience

EasyPG integrates an interactive map experience using Leaflet.js and OpenStreetMap.

Users can:

  • View property locations on a map
  • Identify nearby accommodations
  • Understand the surrounding location before submitting an inquiry
  • Open map-based listings for faster property discovery

🏑 Property Details

Each property listing includes the information users need to make an informed decision.

Property details may include:

  • Property images
  • Monthly rent
  • Address and location
  • Property type
  • Gender preference
  • Availability status
  • Facilities and amenities
  • Ratings and reviews
  • Owner contact options

❀️ Saved Properties

Users can save preferred listings and revisit them later without searching again.

This helps users:

  • Shortlist multiple properties
  • Compare accommodation options
  • Keep track of preferred listings
  • Continue their search across multiple sessions

πŸ“© Inquiry and Visit Requests

Interested users can submit inquiries or request a property visit directly from the application.

The inquiry workflow allows users to:

  • Select a preferred visit date
  • Provide contact information
  • Send a message to the property owner
  • Track booking or visit requests
  • Receive status updates and notifications

πŸ“ž Direct Owner Contact

Users can contact property owners using supported communication options.

Available contact methods may include:

  • Phone calls
  • WhatsApp
  • In-app inquiries
  • Visit requests

πŸ§‘β€πŸ’Ό Host Dashboard

Property owners have access to a dedicated host experience for managing their accommodations.

Hosts can:

  • Create new property listings
  • Upload property images
  • Add rent, location, facilities, and availability details
  • Update existing listings
  • Manage incoming inquiries
  • Review booking and visit requests
  • Monitor listing performance
  • Change property availability

πŸ” Authentication and Role Management

EasyPG uses Clerk for authentication and supports role-based access.

The application supports:

  • Email and password authentication
  • Google authentication
  • Secure session handling
  • Guest and host roles
  • Protected routes and APIs
  • Role-specific dashboards and actions

πŸ”” Notifications

The notification system helps users and hosts stay informed about important activity.

Notifications may include:

  • New inquiry alerts
  • Booking request updates
  • Visit request status changes
  • Property availability updates
  • Host responses

πŸ‘₯ User Roles

EasyPG supports two primary roles:

Role Capabilities
Guest Search properties, apply filters, view maps, save listings, contact hosts, and submit visit or booking requests
Host Create listings, upload images, update availability, manage inquiries, and review booking requests

🏘️ Property Categories

EasyPG supports multiple accommodation types:

  • Paying Guest accommodations
  • Hostels
  • Mess accommodations

Listings may include amenities such as:

  • Wi-Fi
  • Air conditioning
  • Food
  • Laundry
  • Parking
  • Security
  • CCTV
  • Gym
  • Power backup
  • Water supply
  • Furnished rooms

πŸ› οΈ Tech Stack

Mobile Application

  • React Native
  • Expo
  • Expo Router
  • TypeScript
  • NativeWind
  • Phosphor Icons
  • React Native WebView
  • Leaflet.js
  • OpenStreetMap

Backend

  • Node.js
  • Express.js
  • TypeScript
  • REST APIs
  • Drizzle ORM

Database and Services

  • PostgreSQL
  • Neon Database
  • Clerk Authentication
  • Cloudinary
  • Render
  • Expo Application Services

πŸ—οΈ System Architecture

React Native Mobile App
        β”‚
        β”‚ REST API
        β–Ό
Node.js + Express Backend
        β”‚
        β”œβ”€β”€ Clerk Authentication
        β”œβ”€β”€ Cloudinary Media Storage
        β”œβ”€β”€ Neon PostgreSQL Database
        └── Drizzle ORM

βš™οΈ Installation

1. Clone the repository

git clone https://github.com/YOUR_USERNAME/EasyPG.git
cd EasyPG

2. Install mobile application dependencies

cd client
npm install

3. Install backend dependencies

cd ../server
npm install

πŸ” Environment Variables

Create a .env file inside the backend directory:

PORT=5000
DATABASE_URL=your_neon_postgresql_url

CLERK_SECRET_KEY=your_clerk_secret_key

CLOUDINARY_CLOUD_NAME=your_cloudinary_cloud_name
CLOUDINARY_API_KEY=your_cloudinary_api_key
CLOUDINARY_API_SECRET=your_cloudinary_api_secret

CLIENT_URL=your_client_url

Create a .env file inside the Expo application directory:

EXPO_PUBLIC_API_URL=your_backend_api_url
EXPO_PUBLIC_CLERK_PUBLISHABLE_KEY=your_clerk_publishable_key

Never commit .env files or private credentials to the repository.


▢️ Running the Project

Start the backend server

cd server
npm run dev

Start the Expo application

cd client
npx expo start

The mobile application can be opened using:

  • Expo Go
  • Android Emulator
  • iOS Simulator
  • Expo Development Build

πŸ—„οΈ Database Setup

Generate and apply the Drizzle database migrations:

cd server
npm run db:generate
npm run db:migrate

Database commands may vary depending on the scripts configured in package.json.


πŸ”Œ API Overview

Primary API resources include:

/api/users
/api/properties
/api/properties/nearby
/api/saved-listings
/api/inquiries
/api/booking-requests
/api/notifications

Protected endpoints require a valid Clerk authentication session.


πŸš€ Deployment

EasyPG can be deployed using the following services:

Service Platform
Mobile Application Expo Application Services
Backend API Render
Database Neon PostgreSQL
Media Storage Cloudinary
Authentication Clerk

Backend URL

https://your-easypg-backend.onrender.com

Application Download

APK: Add your application download link here

πŸ›£οΈ Product Roadmap

Planned improvements include:

  • Online rent payment support
  • Verified property and owner badges
  • User reviews and ratings
  • In-app messaging between guests and hosts
  • Property comparison tools
  • Advanced map-based discovery
  • AI-powered accommodation recommendations
  • Dedicated administrator dashboard
  • Property reporting and moderation
  • Booking history and digital receipts

🀝 Contributing

Contributions, suggestions, and issue reports are welcome.

Contribution workflow

  1. Fork the repository
  2. Create a feature branch
git switch -c feature/your-feature-name
  1. Commit your changes
git commit -m "feat: add your feature"
  1. Push the branch
git push origin feature/your-feature-name
  1. Open a pull request

πŸ“„ License

This project is licensed under the MIT License.

See the LICENSE file for more information.


πŸ‘¨β€πŸ’» Author

Kalyan Manna Full-Stack Developer

  • GitHub: Kalyan-github-4
  • LinkedIn: Add your LinkedIn profile URL
  • Portfolio: Add your portfolio URL

⭐ Support

If you find EasyPG useful, consider giving the repository a star.

Built with ❀️ to make accommodation discovery simpler, faster, and more accessible.

About

EasyPG is a mobile-first PG and rental discovery platform built with React Native and Expo, designed to simplify finding, listing, and managing paying guest accommodations.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages