📗 Table of Contents

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

📖 Blog App

Blog App is a classic example of a blog website. I created 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

Client

• HTML, CSS
• JavaScript

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• [Authentication, Author can manage his posts and comments]
• [Admin can manage all]
• [Guest User can navigate the App and read bu can't create/like a post or make a comment or ]
• [API documentation based on swagger UI]

(back to top)

📇 Entity Relationship Diagram

🚀 Live Demo

• in progress 😄 Live Demo Link

(back to top)

API Documentation

💻 Getting Started

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

Prerequisites

In order to run this project you need: Git and Ruby

 gem install rails

Install

Install this project with:

  bundle install

  npm install

Create Database (Mandatory)

rails db:create

If you have made a migration then run this command

rails db:migrate

rails db:seed

Usage

To run the project, execute the following command:

  rails server or rails s

Run tests

rspec

View API documentation

http://localhost:3000/api-docs/

(back to top)

👥 Authors

👤 Michael Mesfin

• GitHub: @michael-duke
• Twitter: @MikeDuke21
• LinkedIn: MICHAEL MESFIN

👤 Conor Follette

• GitHub: @Amtresu

(back to top)

🔭 Future Features

• [Improve UI, maybe integrate with esbuild or webpacker]
• [Re-write Controller specs]
• [Improve Request specs]
• [Improve Integration Specs for 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

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank:

• Microverse
• Coding Partners
• Code Reviewers
• Vitor Guedes Madeira

(back to top)

❓ FAQ

• [How to run tests?]

  • [You can run tests with the following command:]

  rspec or bundle exec rspec

• [Question_2]

  • [Answer_2]

(back to top)

📝 License

This project is MIT licensed.

(back to top)