🏠 Kinship Backend

A robust Node.js RESTful API server powering the Kinship platform 🚀

---

📋 Table of Contents

• Overview
• ✨ Features
• 🛠️ Technology Stack
• 🚀 Getting Started
• 📚 API Documentation
• 🏗️ Project Structure
• ⚙️ Environment Variables
• 🤝 Contributing
• 📄 License
• 📞 Support & Contact

---

🌟 Overview

Kinship Backend is a powerful and scalable Node.js RESTful API server designed to power the Kinship platform—a comprehensive social and support network for parents, caregivers, and communities.

This backend provides a complete ecosystem including:

• 🔐 Secure Authentication & Authorization
• 💬 Real-time Chat & Messaging
• 👥 Smart Group Management
• 🏘️ Community Forums & Topics
• 📅 Event Creation & Scheduling
• 🔔 Push Notifications
• 📊 Admin Dashboard

Built with scalability, security, and performance in mind, it leverages modern technologies to deliver a seamless experience for both web and mobile clients.

---

✨ Features

🔐 Authentication & Security

• JWT-based Authentication with Passport.js
• Role-based Authorization system
• Email Verification with OTP
• Password Reset functionality
• Social Login integration (Google, Apple)

👥 User & Group Management

• Profile Management with detailed user information
• Smart Group Matching based on kinship reasons
• Group Creation with minimum member requirements
• User Blocking/Unblocking system
• Profile Completion tracking

💬 Real-time Communication

• Socket.io Integration for real-time messaging
• Group Chat functionality
• Private Messaging between users
• File & Media Sharing support
• Message Search capabilities
• Read Receipts and typing indicators

🏘️ Community Features

• Community Forums with topics
• Post Creation with media support
• Like & Comment system
• Community Joining/Leaving
• Content Moderation tools

📅 Event Management

• Event Creation with details
• Event Scheduling with reminders
• RSVP System (Yes/No/Maybe)
• Upcoming Events listing
• Event Notifications via push

🔔 Notifications

• Push Notifications via Firebase FCM
• Email Notifications via SendGrid
• In-app Notifications system
• Customizable Notification preferences

🛡️ Security & Validation

• Input Validation with Joi schemas
• Data Encryption for sensitive information
• Rate Limiting protection
• CORS Configuration for security
• Error Handling middleware

⚡ Performance & Monitoring

• Background Jobs with node-cron
• Database Optimization with Mongoose
• Caching Strategies implementation
• API Documentation with Swagger UI

---

🛠️ Technology Stack

Category	Technology	Version
Runtime	Node.js	18+
Framework	Express.js	4.17+
Database	MongoDB	6.8+
ODM	Mongoose	6.8+
Real-time	Socket.io	4.7+
Authentication	Passport.js + JWT	Latest
Validation	Joi	17.4+
Notifications	Firebase Admin SDK	11.8+
Email	Nodemailer + SendGrid	Latest
Documentation	Swagger UI	4.1+
Process Manager	PM2	Latest
Development	Nodemon + Babel	Latest

---

🚀 Getting Started

📋 Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v18 or higher)
• npm or yarn package manager
• MongoDB instance (local or cloud)
• Git for version control

🛠️ Installation

1. Clone the repository

   git clone https://github.com/skyroomdev/Kinship-Backend.git
   cd Kinship-Backend

2. Install dependencies

   npm install

3. Configure environment variables

   # Create .env file in root directory
   cp .env.example .env  # if example exists
   nano .env

4. Start the development server

   # Development mode with hot reload
   npm run start
   
   # Production mode with PM2
   npm run start:dev

5. Verify installation

   • Server should start on http://localhost:8001
   • API docs available at http://localhost:8001/api/documentation

---

📚 API Documentation

🔍 Interactive API Docs

Once the server is running, access the comprehensive API documentation:

🌐 Swagger UI: http://localhost:8001/api/documentation

📖 API Endpoints Overview

Module	Base Path	Description
Authentication	/api/v1/auth	Login, register, OTP verification
Users	/api/v1/user	Profile management, settings
Groups	/api/v1/group	Group creation and management
Chat	/api/v1/chat	Real-time messaging
Events	/api/v1/event	Event creation and management
Community	/api/v1/community	Forums and posts
Comments	/api/v1/comment	Comment system
Notifications	/api/v1/notification	Push notifications

🔐 Authentication

All protected endpoints require a Bearer token in the Authorization header:

Authorization: Bearer <your-jwt-token>

---

🏗️ Project Structure

kinship-backend-development/
├── 📁 app.js                 # Main application entry point
├── 📁 package.json           # Dependencies and scripts
├── 📁 swagger.yaml           # OpenAPI specification
├── 📁 .babelrc              # Babel configuration
├── 📁 nodemon.json          # Nodemon configuration
│
├── 📁 src/                   # Source code
│   ├── 📁 auth/             # Authentication module
│   ├── 📁 user/             # User management
│   ├── 📁 group/            # Group functionality
│   ├── 📁 chat/             # Real-time chat
│   ├── 📁 events/           # Event management
│   ├── 📁 community/        # Community features
│   ├── 📁 comments/         # Comment system
│   ├── 📁 notification/     # Push notifications
│   ├── 📁 admin/            # Admin dashboard
│   └── 📁 common/           # Shared utilities
│
├── 📁 model/                # Mongoose models
├── 📁 routes/               # API route definitions
├── 📁 public/               # Static assets
├── 📁 views/                # EJS templates
└── 📁 seeder/               # Database seed scripts

---

⚙️ Environment Variables

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

# Server Configuration
PORT=8001
NODE_ENV=development
BASE_URL=http://localhost:8001

# Database
DB_MONGO_URL=mongodb://localhost:27017/kinship

# Authentication
JWT_SECRET=your-super-secret-jwt-key
AES_ENC_KEY=your-aes-encryption-key
AES_IV=your-aes-iv-key

# Firebase (Push Notifications)
FIREBASE_PROJECT_ID=your-project-id
FIREBASE_PRIVATE_KEY=your-private-key
FIREBASE_CLIENT_EMAIL=your-client-email

# Email (SendGrid)
SENDGRID_API_KEY=your-sendgrid-api-key
MAIL_FROM=dev@findkinship.com

# CORS
ALLOW_ORIGIN=http://localhost:3000

# SSL (Production)
IS_SECURE=false
SSL_CERT_BASE_PATH=/path/to/ssl/certs

---

🤝 Contributing

We welcome contributions from the community! Here's how you can help:

🐛 Reporting Bugs

• Use the GitHub Issues page
• Provide detailed information about the bug
• Include steps to reproduce the issue

💡 Suggesting Features

• Open a new issue with the "enhancement" label
• Describe the feature and its benefits
• Discuss implementation details

🔧 Pull Requests

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📋 Development Guidelines

• Follow the existing code style
• Add tests for new features
• Update documentation as needed
• Ensure all tests pass before submitting

---

📄 License

This project is licensed under the ISC License - see the LICENSE file for details.

---

📞 Support & Contact

🆘 Getting Help

• GitHub Issues: Report bugs or request features
• Documentation: Check the API Documentation

Contact Method	Icon	Details
📧 Development Team		skyroomdev1@gmail.com
📱 Telegram Support		@skyroom07
🐛 Bug Reports		GitHub Issues

🌐 Links

• Repository: GitHub
• Issues: GitHub Issues
• Pull Requests: GitHub PRs

---

Made with ❤️ by the Kinship Team