README.md

📗 Table of Contents

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

📖 Blog

Blog is a classic example of a blog website. That show the list of posts and empower readers to interact with them by adding comments and liking posts. This is the used data model.

🛠 Built With

Tech Stack

Client

• Ruby on Rails

Server

• Active Storage Validation
• Browser
• Bullet
• Bulma
• Cancancan
• Capybara
• Chartkick
• Devise
• Factory Bot
• Faker
• FriendlyId
• JWT
• OmniAuth Rails CSRF Protection
• OmniAuth GitHub
• OmniAuth Google OAuth2
• Pagy
• RSpec Rails
• Rubocop
• Stimulus
• Turbo Rails

Database

• PostgreSQL
• ElephantSQL

Key Features

• REST API
• Omniauth
• API documentation
• Real time update analytic charts

(back to top)

🚀 Live Demo

• Render

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

Ruby

Setup

Clone this repository to your desired folder:

using HTTPS:

  git clone https://github.com/ElsonOtake/Blog_App.git
  cd Blog_App

using an SSH key:

  git clone git@github.com:ElsonOtake/Blog_App.git
  cd Blog_App

using GitHub CLI:

  git clone gh repo clone ElsonOtake/Blog_App
  cd Blog_App

Install

Fill in the environment variables

  DATABASE_DEV_USERNAME=postgres_username
  DATABASE_DEV_PASSWORD=postgres_password
  GITHUB_ID=github_client_id
  GITHUB_SECRET=github_client_secret
  GOOGLE_ID=google_client_id
  GOOGLE_SECRET=google_secret_key

Install this project with:

  bundle install
  rails db:create db:migrate db:seed

Usage

To run the project, execute the following command:

  bin/dev

Open http://localhost:3000/ on your browser.

Run tests

To run tests, run the following command:

  bundle exec rspec spec/features
  bundle exec rspec spec/models
  bundle exec rspec spec/requests
  rails test test/models
  rails test test/controllers
  rails test test/integration
  rails test test/system

To generate the API documentation:

  bundle exec rake rswag

API documentation address.

(back to top)

👥 Authors

👤 Elson Otake

• GitHub: elsonotake
• Twitter: @elsonotake
• LinkedIn: elsonotake

👤 Jesús Vázquez

• GitHub: @jevazquezb
• Twitter: @javb_1187
• LinkedIn: @jevazquezb

👤 Addisu Haile

• GitHub: @Addisu87
• Twitter: @AddisuTedla
• LinkedIn: Addisu Tedla

(back to top)

🔭 Future Features

• Add new features to API documentation

(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
• W3Schools
• Stack Overflow

(back to top)

📝 License

This project is MIT licensed.

(back to top)