README.md

real-estate-management

A online property management solution for real estate and physical property management. This can include residential, commercial, and land real estate. a software developed to connect property managers and potential buyers.

🚧 frontend/ work in progress 🚧.

🚧 backend-fastify/ work in progress 🚧.

LIVE DEMO

Dependencies

Frontend

• Ionic 8+
• Angular 17+
• leaflet 1.7+
• chartjs 3.5+

Backend

• Node
• fastify 4+
• mongoDB

SETUP

Frontend (Part)

1.1 navigate to frontend/ directory.

#  navigate to frontend 
$ cd frontend

1.2 Fill the desired environment variables:

• navigate to frontend/src/environments
• set values to variables (ex. api.url)

  api: {
    server: 'http://localhost:8000/', <-- server URL
    mapKey: '', <-- Leaflet map key,
    googleAuthClientId: '', <-- google Auth CLient ID for Social signin
    webSocketUrl: 'ws://localhost:8000/websocket' <-- websocket URL
  }

2. then install dependencies & run ionic serve

In terminal - command

# install dependencies
$ npm install

# serve frontend
$ ionic serve

Backend-Fastify (Part)

1.1 navigate to backend-fastify/ directory.

cd backend-fastify/

1.2 create .env file & add variables:

• copy .env.example & re-name it to .env
• set your desired variable value

PORT=8000
LOGGER=true
SALT=12
SECRET_KEY='secret'
DB_CONNECT=mongodb://localhost:27017/rem-db

2. then install dependencies & run dev

In terminal - command

#  navigate to backend-fastify 
$ cd backend-fastify

# install dependencies
$ npm install

# start server
$ npm start `or` $ npm run dev

2.1 Database seeder(optional)

• Make sure .env is configured & dependencies are installed
• Will populate database with dummy data.

⚠️ This will delete existing records in the database document.

⚠️ Make a backup if needed

$ npm run db:seeder

dummy user:

  fullName: "test tester",
  email: "[email protected]",
  password: "password"

  You can use this to signin.

Routes

/docs/
/users/
/auth/
/properties/
/enquiries/