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:
- Make sure that you have postgres installed. On a mac, the easiest way to get started is Postgres.app.
- Run
git clone https://github.com/ztcollazo/bookwyrm.git
- Start the postgres server.
- Run
rails db:migrate
-
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.