Giter Club home page Giter Club logo

blog-api's Introduction

๐Ÿ” Blog app: add API endpoints

In this project I create API endpoints that allow users to interact with Social app. The users must be authenticated first.


๐Ÿ’ป Previews

Signup Page Signup

Login Page Login

๐Ÿ› ๏ธ Built With

  • Ruby: 2.5.0
  • Rails: 5.2.4
  • Postgres: >=12.11

๐Ÿ› ๏ธ How to run the App

  • Prerequisites

    • Ruby: 2.5.0
    • Rails: 5.2.4
    • Postgres: >=12.11

๐Ÿ› ๏ธ Getting Started

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

  1. Open Terminal.
  2. Navigate to your desired location to download the contents of this repository.
  3. Clone this repository:
  git clone https://github.com/Qoosim/blog-api.git
  1. Run
  cd blog-api

๐Ÿ› ๏ธ Setup

  • Instal necessary gems with:
  bundle install
  • Setup database with:
   rails db:create
   rails db:migrate

๐Ÿ•น๏ธ Usage

  • Navigate to the root directory of the project
  • Run
  rails server
  • Open a browser and visit
 `http://localhost:3000/` or 127.0.0.1:3000
  • Sign in or sign up to create events!

๐Ÿงช Testing

  • Run
  rspec -f -d

๐ŸŽ‰ Features

API endpoint to list all posts for a user

API endpoint to list all comments for a post

API endpoint to add a comment to a post

For API Documentation

  • visit http://localhost:3000/api-docs

๐Ÿ•น๏ธ Contributions, Issues & Forking

If you have any issues setting up the project or you come across any unintended bugs or problems, please do submit an issue to the Blog-API page.

If you want to make your own changes, modifications or improvements to this project, go ahead and Fork it!

  1. Fork it
  2. Create your working branch (git checkout -b [choose-a-name])
  3. Commit your changes (git commit -am 'what this commit will fix/add/improve')
  4. Push to the branch (git push origin [chosen-name])
  5. Create a new Pull Request

๐Ÿ‘จ๐Ÿฝโ€๐Ÿ’ป Author

Qoosim AbdulGhaniyy

๐Ÿงด Show Your Support

Give a โญ๏ธ if you like this project!

blog-api's People

Contributors

bolah2009 avatar nidalaa avatar qoosim avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.