README.md

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run Test
  • Run Linters
  • Run Endpoints
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 [Blog App]

The Blog app is a classic blog design website. ln which we can create, show the list of posts and empower readers to interact with them by adding comments and liking posts.

[Blog App] is a ruby blog website.

🛠 Built With

Tech Stack

Blog App is backend project

Database

• PostgreSQL

Key Features

We can do CRUD operations on following things:

• Posts
• Comments
• Likes
• Users

(back to top)

🚀 Live Demo

Add a link to your deployed project.

• Comming Soon 🎈

(back to top)

💻 Getting Started

In order to start with this project do as follows :

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

Prerequisites

In order to run this project you need:

gem install rails

Setup

Clone this repository to your desired folder:

git clone git@github.com:Strangeal/Blog-app.git

then

cd Blog-app

Install

Install this project with:

bundle install

Usage

rails s

Run Test

To run app test. run the following commad:

rspec

Run Linters

To run tests, run the following command:

rubocop

OR

rubocop -a

it will automatically correct the errors

Api-Endpoint-Testing

• Add user to database using(postman) on this path http://localhost:3000/api/v1/register

  name: "Tom",
  photo: "https://res.cloudinary.com/dxsom7jmx/image/upload/v1674721420/Meta%20tags/girl-2696947_1280_2_ct8ivd.jpg",
  bio: "Teacher from Mexico.",
  email: "tom@apple.com",
  password: "mysecret@12",
  password_confirmation: "mysecret@12",
  role: "admin",
  jti: "sdhfsh64y4" )

• Check your teminal for comfirmation link to verify account
• Check out terminal after verification to copy the jti key generated dusring sign up
• Add the copied jti key in this directory config/devise.rb on line 312 after the sacret
• Open postman and navigate to this routes http://localhost:3000/api/v1/login add your login details as body and make a POST request to log in
• Click on headers and copy the authentication key
• Make a GET request to this path http://localhost:3000/api/v1/users/ and add the authentication key you copied as a bearer token to get access to database

(back to top)

👥 Authors

👨‍💻 Justice Bajeri

• GitHub: Link to Github Profile
• Twitter: Link to Twitter Profile
• LinkedIn: Link to LinkedIn Profile

👤 Temitope Ogunleye

• GitHub: @topeogunleye
• Twitter: @tope_leye
• LinkedIn: ogunleye

(back to top)

🔭 Future Features

In upcoming weeks I will add some features as mentioned below

• Authentication and Authorization
• API & Documentation
• High UI

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project then please give a ⭐️ and also share your feedback using github_issues.

(back to top)

🙏 Acknowledgments

❤️ RoR Documentation

(back to top)

📝 License

This project is MIT licensed.

(back to top)