rustam-tolipov/social-media-api

Introducing our API, which is modeled after Instagram and provides a complete solution for creating your own social networking app. Using Swagger UI for streamlined integration and simple navigation, and built with Ruby on Rails 7. Easily discover the power of social connectivity!

Social Media API

This API is a clone of Instagram's functionality and it provides a comprehensive solution for creating a social media app. Built with Ruby on Rails 7 and equipped with Swagger UI, this API offers seamless integration and easy navigation.
Explore the docs »

View Demo · Report Bug · Request Feature

Guest User

LOGIN:

 email: tester@gmail.com
 password: password

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. License
6. Contact

About The Project

The Instagram Clone API is a powerful tool for creating a social media application with all the features of Instagram. Built using Ruby on Rails 7, the API is equipped with a variety of features to provide a seamless user experience. The API is designed to be easy to integrate, with Swagger UI for easy navigation and Devise for secure authentication.

(back to top)

Built With

• Ruby
• Rails
• Swagger.UI
• Cloudinary
• RSpec

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

rails -v
Rails 7.0.4

ruby -v
ruby 3.1.3

Installation

1. Clone the repo

   git clone https://github.com/Rustamxon7/social-media-api.git

2. Run bundler

   bundle i

3. For testing run

   rspec spec

(back to top)

Usage

Using the Instagram Clone API is simple and straightforward. The API provides a variety of endpoints for performing different operations, such as creating and managing user accounts, creating and viewing posts, managing comments and likes, following other users, searching for users by username, and viewing suggestions for other users to follow.

(back to top)

Roadmap

• User
• Posts
• Comments
• Likes
• Follows
• Search by Username

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @Rustamjon7777 - rustamxontolipov788@gmail.com

Project Link: https://github.com/Rustamxon7/social-media-api

(back to top)