Logo uminari

Overview

Introduction

Welcome to the documentation for our free API designed for front-end developers. Built on Node.js, this API provides a comprehensive set of endpoints to facilitate the creation and management of social media platforms. Whether you're building user profiles, managing posts, or integrating chat functionalities, our API is ready to be used in production environments without the need for installation.

This API uses AWS S3 for storing images and videos, ensuring reliable and scalable media management. This is the first version of the API, and we plan to continue updating and improving it based on user feedback and emerging requirements.

Key Features

  • Comprehensive API Endpoints: The API includes routes for user authentication, profile management, post creation, comments, likes, notifications, and more.
  • Real-Time Communication: Using Socket.io, the API supports real-time chat functionality, allowing for interactive user experiences.
  • Scalable: Built on Node.js and MongoDB, the API is designed to handle scalable applications efficiently.
  • Easy Integration: The API is designed to be easily integrated into your front-end projects, offering a straightforward approach to connecting your application with back-end services.

Advantages

  • No Installation Required: The API is ready to use out of the box. Simply connect to the endpoints and start integrating with your front-end application.
  • Open-Source: Benefit from a community-driven project with ongoing support and updates.
  • Comprehensive Documentation: Detailed routes and usage examples are provided to help you get started quickly and effectively.

Getting Started

To begin using the API, refer to the API Endpoints section for detailed information on each route, including request formats and response examples. Explore how to set up authentication, handle user data, and implement key features like real-time notifications and chat.

Note: Examples in this documentation are provided in React, but the API can also be used with other technologies such as Angular, Vue, and Vanilla JS.