Skip to content

Latest commit

 

History

History
90 lines (56 loc) · 2.79 KB

README.md

File metadata and controls

90 lines (56 loc) · 2.79 KB
Raw

Blog app

A blog app built using Ruby on Rails that allows you to make posts about anything you want.

You can also use the application API to query about posts of an individual author, check the post's comments, and even make a new one.

You need to register with your email and password. After completion, you will receive an email asking you to confirm your account. In that email, you will also receive your API token to use the API.

API

To use the API make sure to have your token.

Endpoints

  • POST https://safe-brook-54426.herokuapp.com/api/users/{author_id}/show
    Retreives a list of posts for the specified author. The body of the request must be of type json and contain the API token

  • POST https://safe-brook-54426.herokuapp.com/api/posts/{post_id}/comments
    Retrieves a list of posts for the specified author. The body of the request must be of type json and contain the API token and the comment (text) to be added

More to be added!!
You can review the documentation by visiting:
Api documentation

Built With

  • Ruby
  • Rails

Prerequisites

  • PostgreSql
  • Ruby (2.7 or newer)
  • Bundle (2.1.4 or newer)

Getting Started

To get a local copy follow these simple steps.

1.- Open the terminal window and clone the repository using this command:
git clone git@github.com:VicPeralta/blogapp.git

2.- Change the directory to the blogapp directory
cd blogapp
3.- Install the project's dependencies by running this command:
bundle install
4.- Change the database configuration file (database.yml) to fit your local database's settings
5.- Start the server using this command:
rails s
6.- Open the browser at this address:
http://127.0.0.1:3000/

Live demo

You can try the functionality of this application by clicking: Demo

Authors

👤 Victor Peralta

👤 Behnam Aghaali

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project! The gem is available as open source under the terms of the MIT License.