📗 Table of Contents

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

📖 Blog app with Rails

Blog app with Rails is a classic example of a blog website that shows the list of posts and empower readers to interact with them by adding comments and liking posts. It follow the following data model (this is an Entity Relationship Diagram):

ERD Diagram

🛠 Built With

Tech Stack

Languages

• Ruby
• Javascript
• HTML
• CSS

Frameworks

• Ruby on Rails

Server

• Puma

Database

• PostgreSQL

Api Endpoints

• POST /api/v1/signup
• POST /api/v1/login
• - GET /api/v1/users/:user_id/posts/:post_id/comments
• - POST /api/v1/users/:user_id/posts/:post_id/comments
• - GET /api/v1/users/:user_id/posts/:post_id/comments/:id
• - GET /api/v1/users/:user_id/posts
• - POST /api/v1/users/:user_id/posts
• - GET /api/v1/users/:user_id/posts/new
• - GET /api/v1/users/:user_id/posts/:id
• - GET /api/v1/users
• - POST /api/v1/users
• - GET /api/v1/users/:id

Key Features

• [Keep user records] -
• [Add comments]
• [Display Comments]
• [Display posts]
• [Delete post]
• [Keep likes records]
• [Like comments]

(back to top)

🚀 Live Demo

• Comming soon

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

Ruby version : ruby 3.1.2p20 run ruby -v Database : PostgreSQL

 gem install rails

Setup

Clone this repository to your desired folder:

Example commands:

  cd my-folder
  git clone [email protected]:Sonickmumba/Blog-app-with-Rails.git

Install

Install this project with:

  cd Blog-app-with-rails
  bundle install

Usage

To run the project, execute the following command:

  rails server or rails s

Run tests

The app is tested using Rspec library you can check the tests by opening your terminal, then change the directory to the location of this repo using this command cd file_path, then run this command gem install rspec, finally run this command rspec spec or rspec spec --format doc for documented test results you should see a screen like that comming soon

Deployment

You can deploy this project using:

• Comming soon

(back to top)

👥 Authors

👤 Sonick Mumba

• GitHub: @Sonickmumba
• Twitter: @Sonick
• LinkedIn: Sonick Mumba

(back to top)

🔭 Future Features

• [Controllers specs]
• [Validation]
• [Views]

(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 it a thumb up : 👍 and share this projects with your friends

(back to top)

🙏 Acknowledgments

I would like to thank...

• Thanks to Microverse for giving the opportunity to learn
• Code reviewers and coding partners
• Hat tip to anyone whose code was used
• Inspiration

(back to top)

❓ FAQ

Add at least 2 questions new developers would ask when they decide to use your project.

• [Question_1]

  • [Answer_1]

• [Question_2]

  • [Answer_2]

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)