/book_recomendation_app

Primary LanguageRuby

📗 Table of Contents

📖 [Book Review]

[Book Review] is a book-tracking application built using Ruby on Rails and PostgreSQL. The app is similar to Goodreads and allows users to keep track of books they have read, are currently reading, and want to read in the future. Users can also rate and review books, create and join book clubs, and discover new books to read through personalized recommendations.

The app utilizes PostgreSQL as its database management system, allowing high scalability and fast data retrieval. Additionally, Spring Boot is used to handling the application's backend services, such as user authentication, book data management, and communication with the Open Library API for search functionality.

🛠 Built With

Postgres Ruby Rails

Tech Stack

This a Rails Api with endpoints for all the models we use in the Front-end. Each model have validations for data integtity.

Front-End Repository

Client
Server
Database

Key Features

Our API have great feautures.

  • Login, SignUp, Logout Endopoints
  • Current User Endpoint
  • JWT Token Authentication

(back to top)

💻 Getting Started

Please Fork or Clone this repo.

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

Prerequisites

In order to run this project you need: Ruby.

 ruby -v

If you get something like this ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [x86_64-darwin21], you have ruby installed. Otherwise follow this tutorial to install it.

Ruby On Rails.

 rails -v

If you get something like this Rails 7.0.4, you have rails installed. Otherwise type:

 gem install rails

PostgreSQL.

 psql --version

If you get something like this psql (PostgreSQL) 14.6, you have postgreSQL installed. Otherwise follow this tutorial to install it.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git https://github.com/jaferIdrees/book_recomendation_app.git

Install Gems

Install this project with:

  cd my-project
  bundle install

Usage

To run the project, execute the following command:

  rails server

Your server will run on http://127.0.0.1:4000

Run tests

To run tests, run the following command:

  bin/rails rspec spec

👥 Authors (Synergy team)

This is the awesome team (4 members) that built this project.

👤 Ja'fer Yousef

👤 Romita Pawar

👤 Sneha Singh

👤 Olatunde O

(back to top)

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project...give us a ⭐️.

(back to top)

📝 License

This project is MIT licensed.

(back to top)