🏗️ Neighbourly – Real Estate Backend (NestJS)

This is the backend service for Neighbourly, a platform for real estate listings. Built using NestJS, it handles property listings, and communication with PostgreSQL using TypeORM.

---

🚀 Features

• 🏡 CRUD APIs for real estate listings
• 🧾 wishlist features
• 🧩 Modular microservice architecture
• 🗃️ PostgreSQL with TypeORM migrations
• 📄 Swagger API docs (upcoming)

---

🧱 Tech Stack

• NestJS
• PostgreSQL

---

⚙️ Getting Started

🔨 Installation

git clone https://github.com/nikitapoyarekar05/nexus-be.git
cd nexus-be
npm install

🔐 Environment Variables

Create a .env file in the root:

PORT=3300
DB_HOST=localhost
DB_PORT=5432
DB_USERNAME=your_db_username
DB_PASSWORD=your_password
DB_NAME=your_db_name
DB_SSL=true

---

📦 Running the App

# Development
npm run start:dev

# Production build
npm run build
npm run start:prod

---

🔄 Database Migrations

# Generate new migration
npm run migration:generate -- ./src/migrations/YourMigrationName

# Run migrations
npm run migration:run

---

🧪 Testing

# Run tests
npm run test

# Coverage
npm run test:cov

---

🌍 Deployment

• Use environments like Railway, Render, or Docker
• Configure env variables as needed
• Ensure DATABASE_URL and JWT_SECRET are properly set

---

🙋‍♀️ Maintainer

Built with ❤️ by @nikitapoyarekar05