InstaBackend

---

A feature-rich backend for an Instagram-like social media platform built with NestJS and PostgreSQL.

📝 Table of Contents

• About
• Getting Started
• Usage
• Deployment
• Built Using
• Authors
• Acknowledgments

🧐 About

InstaBackend is a scalable backend API for a social media platform modeled after Instagram. It includes essential features such as user registration, post management, and interaction functionalities like comments, likes, and following. Built with NestJS, PostgreSQL, and Swagger for API documentation, this project aims to mimic the core functionalities of Instagram while allowing further extensibility.

The main focus of this project is to offer a fully functional backend where users can register, follow each other, create and manage posts and stories, like content, and much more. Future updates will bring additional features to enhance the social experience.

🏁 Getting Started

These instructions will help you set up a local development environment and get the backend up and running for testing and development purposes.

Prerequisites

You'll need the following software installed:

• Node.js (version 20 or later)
• PostgreSQL
• NestJS
• Git

Installing

Clone the repository:

git clone https://github.com/mamalli11/InstagramBackend.git

Navigate into the project directory:

cd InstagramBackend

Install dependencies:

npm install

Set up your PostgreSQL database and update the environment variables in the .env file with your database credentials.

Run the application:

npm run start:dev

🎈 Usage

Once the backend is running, Swagger documentation is available at /swagger, which provides detailed descriptions of all available API endpoints, such as user registration, post creation, and interaction features.

🚀 Deployment

For deployment to a live system, configure your production environment and run:

npm run build
npm run start:prod

You can deploy using Docker as well. Make sure to set up your PostgreSQL instance and update the .env variables accordingly.

⛏️ Built Using

• NestJS - Server Framework
• PostgreSQL - Database
• Swagger - API Documentation
• Node.js - Server Environment

✍️ Authors

• @mamalli11 - Initial work

🎉 Acknowledgements

• Thanks to the NestJS community for the resources and support
• Inspired by the core functionalities of Instagram