Olivier-Kango/blog_app

The Blog app will be a classic example of a blog website. I create a fully functional website that will show the list of posts and empower readers to interact with them by adding comments and liking posts.

Blog app

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🤝 Contributing
• ⭐️ Show your support
• 📝 License

📖 Blog app

The Blog app will be a classic example of a blog website. I create a fully functional website that will show the list of posts and empower readers to interact with them by adding comments and liking posts.

🛠 Built With

Tech Stack

Server

• Ruby on Rails
• Postgres

(back to top)

ERD Diagram

Key Features

• User Sign_up and Sing_in
• User can Comment and Like
• User can Delete Comment

(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:

• IDE or code editor: VsCode, atom, sublime...
• To have Ruby, RoR gem and Git installed on your system.

Setup

Clone this project on your local machine using the following command on your terminal:

  git clone https://github.com/Olivier-Kango/creating_data_model.git

Install

Run the following command to install all project's dependencies:

bundle install

Run the following command to install Rspec for tests:

gem install rspec

Usage

To run the project, execute the following command:

  rails s

Run Tests

Run the following command to catch all style errors:

rubocop

Run the following command for the rspec tests(with details):

rspec ./spec --format documentation

👥 Author

👤 Olivier Kango

• GitHub: @githubolivier
• Twitter: @twitterolivier
• LinkedIn: LinkedIn

👤 Jeremiah Melfah

• GitHub: GitHub
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

Features to add to the project.

• Add Devise
• Add authorization rules
• Integration specs for Views

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

Give this project a star if you like it !

❓ FAQ

• Do I have to have any previous knowledge about ruby to use this project?

  • No!

• How to use this project?

  • check the Getting Started section to have a complete guid on how to setup and run teh project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)