/BlogApp

The Blog App is a Ruby on Rails App that is meant to display a list of posts and users, display a list of users and their details, and display posts. With the role of an admin a user can delete comments and posts, but for a regular user they can only delete their posts and comments

Primary LanguageRubyMIT LicenseMIT

Blog App | Ruby on Rails Project

πŸ“— Table of Contents


Blog App

"Blog App" is a website built with Ruby on Rails and PostgreSQL that allows users to create and publish posts, write comments, and like posts.


πŸ›  Built With

Tech Stack

Backend
Frontend

Key Features

  • Ruby on Rails framework
  • Use Linters to check code quality
    • Rubocop
    • Stylelint
  • MVC architectural/design pattern
  • Data persistent in PostgreSQL
  • Test the application with rspec
  • Follow Microverse's list of best practices

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

  • A code editor (we recommend Visual Studio Code)

  • Git and a GitHub account

Setup

Clone this repository to your desired folder by using this πŸ‘‡οΈ command :

git clone https://github.com/Kidd254/BlogApp.git

Install

Go to the project directory:

 cd blog-app

Before to run the program, verify that you have Ruby on Rails installed on your OS running the following command:

 rails --version

It should show you the version of ruby on rails ​​installed. If this does not happen and only an error message is displayed, then you should either verify your installation or install Ruby on Rails from scratch.

Download and Install Ruby on Rails

Usage

Run the following command inside the project folder to start the application:

 rails s

This will start the application on your local server. You can now open your browser and go to http://localhost:3000/ to see the application running.

Run tests

To execute the tests, run the following command inside the project folder:

 rspec

(back to top)


πŸ‘₯ Authors

πŸ‘€ Lawrence Muema Kioko

(back to top)


πŸ”­ Future Features

Upcoming improvements:

  • Creating a data model
  • Processing data in models
  • Validations and model specs
  • Controllers
  • Views
  • Forms

(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 and know someone who might find it helpful, please share it. Or give it a star ⭐️ if you like this project!

(back to top)


πŸ™ Acknowledgments

I thank Microverse for this fantastic opportunity, and the code reviewers for their advice and time.

(back to top)


πŸ“ License

This project is MIT licensed.

(back to top)