• 📖 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 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.

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

(back to top)

• Render

(back to top)

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

In order to run this project you need:

Ruby

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

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

To run the project, execute the following command:

 bin/dev

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

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)

👤 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)

• Add new features to API documentation

(back to top)

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

Give a ⭐️ if you like this project!

(back to top)

I would like to thank:

• Microverse
• W3Schools
• Stack Overflow

(back to top)

This project is MIT licensed.

(back to top)