Skip to content

Latest commit

 

History

History
207 lines (154 loc) · 6.34 KB

README.md

File metadata and controls

207 lines (154 loc) · 6.34 KB
Raw

.

🛰Blog App 🚀

📗 Table of Contents

📖 Blog App

A Blog app is similar to a classic blog website. With a fully functional website that shows the list of posts and empowers readers to interact with them by adding comments and liking post The project is a repository consisting of the following files:

  • Ruby files.
  • Rails files.
  • Ruby linters file.

🛠 Built With

Tech Stack

Key Features

  • Display Users, posts, comments on posts, likes on posts
  • Create a new app.
  • Processing data in model
  • Validations and Model spec
  • Setup and controllers
  • The project has a Postgres database set up
  • Create and run the necessary migration files.
  • Table and column names match the ERD diagram with developed

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

  • Ruby installed and running. To get more information, read the installation instructions.
  • You should be able to use IRB.
  • First of all, make sure you have both Ruby & Rails installed on your machine (else You can install Rails just with this simple command gem install rails)

Setup

Clone this repository to your desired folder

  git clone https://github.com/Benawi/Blog-App.git
  cd Blog-App

Install

Install project dependencies with

  bundle install

Run locally

  • Then go to the right folder
$ cd Blog-App

$ bundle

and run to install npm package

$ npm install

make sure the database is up and running.

$ rails db: create

When you add a migration file, you can add commands like

$ rails db: migrate

Run this command line to add some dummy data

$ rails db: seed

Run Tests

Go to your gemfile and add the RSpec gem in the development test group:

group : development, test do  
 gem 'rspec-rails'
end

Then in your terminal run the command:

 $ bundle install

To set up RSpec in your app and create the Spec folder run:

 $ rails generate rspec: install

To run Request specs locally you need just to run the following command in your terminal:

$ rspec spec/model/
$ rspec spec/models/ --format documentation

(back to top)

👥 Authors

👤 Habtamu Alemayehu

👤 : Bwambale

(back to top)

🔭 Future Features

  • Integration specs for Views and fixing n+1 problems.
  • Add Devise.
  • Add authorization rules.
  • Add API endpoints.
  • API documentation.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

(back to top)

⭐️ Show your support

Give me ⭐️ If you like this project!

(back to top)

🙏 Acknowledgments

  • I wanted to take a moment to express my sincere gratitude for the opportunity to work with you all on this project.
  • Microverse, thank you for providing the structure, guidance and community to help me level up my skills as a developer. The experiential learning model has been invaluable in improving my coding abilities and collaboration skills. I appreciate the code reviews and feedback to help me write cleaner, more professional code..

(back to top)

📝 License

This project is MIT licensed.

(back to top)