Place Pulse - Backend

Welcome to the backend repository for Place Pulse, a sophisticated and scalable RESTful API developed using TypeScript and Express. This API is designed to deliver critical functionalities for efficient management of user authentication, property listings, bookings, and various other services. With a focus on performance and security, Place Pulse aims to provide a seamless experience for both users and developers.

Table of Contents

• Introduction
• Technologies Used
• Project Overview
• Key Features
• API Documentation
• Getting Started
  • Installation
  • Running the Server
• Contributing

Introduction

This backend repository serves as the foundation of Place Pulse, delivering a secure and efficient server that supports a wide range of functionalities, including user management, property management, and booking systems. Built with TypeScript, Node.js, and Express, this architecture ensures robust performance and scalability, enabling seamless interaction between users and the application.

Technologies Used

• Node.js
• Express
• TypeScript
• MongoDB
• Mongoose
• JWT (JSON Web Token) for authentication
• bcrypt for password hashing
• Stripe for payment processing
• Socket.io for real-time communication
• CORS for Cross-Origin Resource Sharing
• Morgan for logging HTTP requests

Project Overview

The Place Pulse backend server is architected to deliver a comprehensive RESTful API that facilitates interaction with client applications. It provides a variety of endpoints for managing users, properties, bookings, and notifications, all while ensuring data integrity and security. This design promotes efficient communication and a smooth user experience, making it an essential component of the Place Pulse ecosystem.

Key Features

• User Management:

  • Secure user registration and authentication.
  • Password hashing for enhanced security.

• Subscription System:

  • Allow users to subscribe to services and manage subscription plans.

• Property Management:

  • Create, read, update, and delete property listings.

• Booking System:

  • Facilitate property bookings and manage transactions.

• Stripe Integration:

  • Handle payments securely through Stripe.

• Messaging:

  • Enable users to send and receive messages within the application.

• Real-time Notifications:

  • Send and receive notifications to users.

• Analytics Dashboard:

  • View insights and analytics for better decision-making.

• Content Management:

  • Manage blogs, FAQs, and other content.

API Documentation

For detailed information on the available API endpoints and their usage, please refer to the Postman API Documentation.

Getting Started

Installation

1. Clone the repository:

   git clone https://github.com/iibrahim70/place-pulse-server

2. Navigate to the project directory:

   cd place-pulse-server

Running the Server

1. Install dependencies:

   pnpm i

2. Set up environment variables:

   • Create a .env file in the root directory.
   • Define the following variables:

     # Server Config
     PORT=                 # Server port
     IP_ADDRESS=           # Server IP address
     NODE_ENV=             # Environment (development/production)
     CORS_ORIGIN=          # Allowed CORS origins (comma-separated list)
   
     # Database Config
     DATABASE_URL=         # MongoDB connection string
     COLLECTION_NAME=      # Database name
   
     # Security & JWT
     BCRYPT_SALT_ROUNDS=   # Salt rounds for bcrypt (e.g., 10)
     JWT_ACCESS_SECRET=    # Secret for JWT access token
     JWT_REFRESH_SECRET=   # Secret for JWT refresh token
     JWT_ACCESS_EXPIRES_IN= # JWT access token expiry (e.g., 1d)
     JWT_REFRESH_EXPIRES_IN= # JWT refresh token expiry (e.g., 30d)
   
     # Super Admin
     SUPER_ADMIN_FULLNAME= # Full name of the super admin
     SUPER_ADMIN_EMAIL=    # Super admin email
     SUPER_ADMIN_PASSWORD= # Super admin password
     SUPER_ADMIN_ROLE=     # Super admin role (e.g., SUPER-ADMIN)
     SUPER_ADMIN_IS_VERIFIED= # Super admin verified status (true/false)
     SUPER_ADMIN_STATUS=   # Super admin status (e.g., active)
   
     # SMTP Config
     SMTP_EMAIL_USER=      # SMTP username
     SMTP_EMAIL_PASS=      # SMTP password
   
     # API Keys
     GOOGLE_MAPS_API_KEY=  # Google Maps API key
     STRIPE_SECRET_KEY=    # Stripe secret key
     STRIPE_WEBHOOK_SECRET= # Stripe webhook secret key

3. Run the server:

   pnpm start:dev

The server will start running at http://your_ip_address:your_port

Contributing

Contributions are welcome! If you have any suggestions, improvements, or new features to add, please fork the repository and submit a pull request.