Project Name

Books Library

• This is a basic API built with Ruby on Rails and deployed using Render

Pre-requisites

In order to use this repository you will need the following:

• Operating System (Windows 10+, Linux 3.8+, or MacOS X 10.7+)
• RAM >= 4GB
• Free Space >= 2GB

Built With

This application has been built with the following tools:

• Ruby v2.7.+
• SQlite3 v1.6
• ActiveRecord v7.0.4
• Rake v13.0.6
• Puma v6.1
• rerun v0.14

Setup

You can setup this repository by following this manual

• Clone the repository

    git@github.com:AlexIrungu/phase4finalproject-backend.git
  

• Ensure the ruby gems are setup in your machine

    bundle install
  

• Perform any pending database migrations

    rails db:migrate
  

• Seed data into the database

  rails db:seed
  

• Run the application/start server

    rails s
  

• Open the application from your browser

    http://localhost:3000
  

• Backend Deployment

     https://inkwell-library.onrender.com/
  

Running and testing

You can use the following steps to run the app

Ensure you have either;

• Thunder Client extension
• Postman

Deliverables Endpoints

• GET/books

     https://inkwell-library.onrender.com/books
  

• GET/users

     https://inkwell-library.onrender.com/users
  

• GET/categories

  https://inkwell-library.onrender.com/categories
  

Author

This code has been presented to you by a talented group of individuals

• Alex Irungu
• Benjamin Mutava
• Antony Tulla
• Alvin Njonjo

License

MIT

README

This README would normally document whatever steps are necessary to get the application up and running.

Things you may want to cover:

• Ruby version

• System dependencies

• Configuration

• Database creation

• Database initialization

• How to run the test suite

• Services (job queues, cache servers, search engines, etc.)

• Deployment instructions

• ...