Bookable App

Bookable App

This is the Capstone Project for the Ruby on Rails section of the Microverse curriculum.
Explore the docs »

Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Contact
• Acknowledgements
• How it works

About The Project

User's Profile Page

List of User's Books

List of User's Groups

Capstone projects are solo projects at the end of the each of the Microverse Main Technical Curriculum sections. It is a real-world-like project built with business specifications This project was at the end of the Ruby on Rails curriculum section. For this project, I created an app that allows you to register books that you have read and group them into groups of your choosing. These groups can be either book genres or groups based on bookclubs. You are free to choose how you want to group your books. It also allows you to view books that other users of the app are using but not their personal thoughts on the project. As an extra feature, I decided to implement a search page where you can get information about a particular book via the GoodReads website.

LIVE DEMO

Link to live demo

Built With

This project was built using these technologies.

• Ruby-on-Rails
• Bootstrap
• PostgreSQL
• Amazon's Goodreads API
• AWS S3 Bucket

Getting Started

• To get a local copy up and running follow these simple example steps.

Prerequisites

• Ruby: 2.6.3
• Rails: 5.2.4
• Postgres: >=9.5
• AWS S3 bucket (for the access key and secret key to upload images in production environment)
• Amazon's GoodReads API (for the access key and secret key to gain data about the books)

Install

To test the Bookable App locally, you will need to clone the repository, navigate to it's containing directory, and run the following commands:

Clone the repository and follow the steps to run the app.

• $ git clone git@github.com:BrittanyBlake/Bookable-app.git
• $ bundle install -> run this command to install the required gems
• $ rails db:create -> run this command to create the databade
• $ rails db:migrate -> run this command to run the migration
• $ rails server -> run this command to start the live server
• Open http://localhost:3000/ in tour preferred browser.

---

Additional notes about testing the app locally:

• Please note that if you want to test my app locally you will need a Goodreads Developer key.
• If you are using ubuntu, and you get one or both of the following error message: Error: Failed to build gem native extension or The "libxml2" package isn't available. (RuntimeError), you may need to run these two commands:
  • sudo apt-get install build-essential libcurl4-openssl-dev
  • sudo apt-get install libxml2-dev

---

Run tests

• $ rspec --format documentation

Integration and Unit Test

• Rspec
• Capybara
• FactoryBot
• Faker

Authors

👤 Brittany Blake

• Github: @BrittanyBlake
• Twitter: @bbcodes_
• Linkedin: Brittany Blake

Acknowledgements

• Microverse
• Ruby Documentation
• Template Design By Gregoire Vella

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MIT licensed. Design by Gregoire Vella on Behance.