Property Pulse

A property management application
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Development Team
6. Acknowledgments

About The Project

Property Pulse - A property management application that streamlines all aspects of managing rental properties and fosters a harmonious relationship between landlord and tenant.

Visitor Login

• URL: https://property-pulse.vercel.app
• Email: visitor@manager.com
• Password: password

Please note that our backend server is deployed on Render while our frontend is deployed on Vercel. Render application shuts down after a period of inactivity and it can take a minute or two to start up. After you click "Login", you may have to wait a minute or two and click the Login button again.

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

• Clone the repository
• Install node.js.
• Set up a PostgreSQL instance either locally or in the cloud (Supabase).
• Create a .env file in the backend directory and specify the following values.
  • DATABASE_URL=[Your PostgreSQL database connection string]
• Create a .env.local file in the frontend directory and specifiy the following values.
  • API_URL=http://localhost:8080

Installation

• Main Directory (Change directory to property-pulse): Used to run both the frontend and backend applications simultaneously on the development environment.
  • Install dependencies: This will install concurrently.

  npm i
  

• Backend (Change directory to property-pulse/backend): Root directory for the backend application
  • Install dependencies

  npm i
  

  • Generate Prisma schema

  npx prisma generate
  

  • Migrate to PostgreSQL database

  npx prisma migrate dev
  

• Frontend (Change directory to property-pulse/frontend): Root directory for the frontend application
  • Install dependencies

  npm i
  

• Set up the main, backend, and frontend all at once with this one liner (Change directory to property-pulse before executing this).

  npm i && cd backend && npm i && npx prisma generate && npx prisma migrate dev && cd ../frontend && npm i
  

(back to top)

Usage

1. Frontend
   • Port: 3000
   • NPM Scripts
     • dev: Used for development
     • build: Builds next js
     • start: Starts next js
2. Backend
   • Port: 8080
   • NPM Scripts
     • dev: Used for development
     • tsc: Compiles typescript
     • build: Downloads dependencies, Set up Prisma, and compile typescript
     • start: Starts express js

The Next JS application (Frontend) is hosted on Vercel. The Express application (backend) is hosted on Render. Express on Render may take a few minutes for fully start up. The database instance is hosted on Supabase

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Development Team

• n3ndor
• curtwl
• MattRueter
• mpark4656

(back to top)

Acknowledgments

• Chingu
• alcb1310 for guiding the development team
• jenny-alexander for project ideas and concepts
• RodCato for planning and tech stack selection

(back to top)