BlogApp

📗 Table of Contents

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

📖 BlogApp

BlogApp is a classic example of a blog website. With fully functional website that show the list of posts and empower readers to interact with them by adding comments and liking posts.

• User
• Post
• Comment
• Like

Project requirements

General requirements

• Make sure that there are no linter errors.
• Make sure that you used correct Gitflow.
• Make sure that you documented your work in a professional way.

Ruby requirements

• Follow our list of best practices for Ruby.

🛠 Built With

Tech Stack

• Ruby
• Ruby on Rails
• JavaScript
• PostgreSQL
• GitHub

Key Features

• Project 1: Creating a data model.
• Project 2: Validations and Model specs.
• Project 3: Processing data in models.
• Project 4: Setup and controllers.
• Project 5: Controllers specs.
• Project 6: Views.
• Project 7: Forms.
• Project 8: Integration specs for Views and fixing n+1 problems.
• Project 9: Add Devise.
• Project 10: Add authorization rules.
• Project 11: Add API endpoints.
• Exercise: API documentation.

(back to top)

🚀 Live Demo & Project Presentation

• Live Demo coming soon...

(back to top)

💻 Getting Started

Prerequisites

Everything will be based on the ERD class diagram presented below.

Entity Relationship Diagram (ERD) of Blog App project

Getting Started

To run the project locally, copy up and running follow these simple example steps :

• First of all make sure you have both Ruby & Rails installed in your machine (else You can install Rails just with this simple command gem install rails)

$ git clone ### Setup
- Clone this repository to your computer: git clone https://github.com/ONJoseph/BlogApp.git

• Then go to the right folder

$ cd BlogApp

$ bundle

and run to install npm package

$ npm install

make sure the database is up and running.

$ rails db:create

When you will add migration file then, you can add command like

$ rails db:migrate

Run this command line to add some dummy data

$ rails db:seed

• Finaly run rails s and visit http://localhost:3000/ in your browser!

Run tests :

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

$ bundle exec rspec

16 Request Specs passed

Install

• Write: bundle install
• Write: npm install

Usage

• To test the app:
  • rspec (general)
  • rspec spec/unit/name_of_sile (specific one)

(back to top)

👥 Author

👤 Joseph Ogbole

• GitHub: @ONJoseph
• Twitter: @ONJoseph1
• LinkedIn: LinkedIn

👤 Francisco Quintero

• GitHub: @HunterX-7
• Twitter: @franquin07
• LinkedIn: Francisco Quintero

(back to top)

🔭 Future Features

• Add more interactivity to the function.
• Add more methods to test BlogApp development.
• Add more unique features.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

I really enjoyed working on this project. If you like it show your support by giving a star.

(back to top)

🙏 Acknowledgments

Hat tip to anyone whose code was used.

(back to top)

📝 License

This project is MIT licensed.

(back to top)