Bookwyrm

A book review and discovery website with AI-powered search and recommendations.

railsrubybooks

Bookwyrm is a book review website built on Ruby on Rails that pulls data from Openlibrary. It uses vector similarity for searching and the Disco library for recommendations.

Ruby JS Ruby Heroku

Welcome to BookWyrm!

About

Bookwyrm is a platform for book reviews and recommendations. It is written in Ruby on Rails, and uses artificial intelligence to give recommendations. You can review books, add books, search books and authors, and view other users.

Development

This application uses ruby version 2.7.3, with rbenv for management.

Contributing

Please read the contribution guidelines before opening an issue or pull request.

To run locally:

  1. Make sure that you have postgres installed. On a mac, the easiest way to get started is Postgres.app.
  2. Run git clone https://github.com/ztcollazo/bookwyrm.git
  3. Start the postgres server.
  4. Run rails db:migrate
  5. Run bin/dev. Bookwyrm uses vite_ruby to bundle javascript along with the rails app, so bin/dev runs a foreman process alongside the server.

Testing

Bookwyrm uses RSpec for tests. bin/rspec will run the tests.