rustam-tolipov/rasmga-ol-api

Rasmga Ol API is a RESTful API built with Ruby on Rails. It is a backend for a social media application that allows users to create posts, reels, like, comment, and follow other users. The API is built with a modular structure and is easy to understand and use.

Rasmga Ol API

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

Rasmga Ol API is a RESTful API built with Ruby on Rails. It is a backend for a social media application that allows users to create posts, reels, like, comment, and follow other users. The API is built with a modular structure and is easy to understand and use. It is also well documented and has a list of all the available endpoints and their descriptions.

(back to top)

Built With

• Ruby
• Ruby on Rails
• PostgreSQL
• Render
• Cloudinary
• ActiveModelSerializers

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• bundle

  gem install bundler

• ruby

  rvm install ruby-3.1.3

• rails

  gem install rails -v 7.0.4

• postgresql

  brew install postgresql

Installation

1. Clone the repo

    git clone https://github.com/Rustamxon7/rasmga-ol-api.git

2. Install gems

   bundle install

3. Create database

   rails db:create

4. Migrate database

   rails db:migrate

5. Run server

   rails s

6. Open your browser and go to http://localhost:3000

(back to top)

Usage

By opening the project in your browser, you can see the list of all the available endpoints and their descriptions. The REST API is located at http://localhost:3000/api/v1/ and you can view the list of all the available routes by visiting http://localhost:3000/api/v1/routes

(back to top)

Roadmap

• Login and Registration
  • User Registration
  • User Login
  • User Logout
• User
  • User Profile
  • User Info
  • User Posts
  • User Edit
  • User Follow
  • User Unfollow
• Posts
  • Create Post
  • Delete Post
  • Like Post
  • Comment Post
• Reels
  • Create Reel
  • Delete Reel
  • Like Reel
  • Comment Reel

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

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

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

(back to top)

Contact

Instagram - @rustamtolipov_

Gmail - rustamxontolipov788@gmail.com

Project Link: https://github.com/Rustamxon7/rasmga-ol-api

(back to top)

(back to top)