Book shelf is a reading list app. It allows users to make a collection of books and with it make organized reading lists based on different genres. Books and reading lists can be set to either public or private. Public reading lists can have likes only. A user can like and comments on a certain book. Only a logged in user can add books, create reading lists and actively engage with the other content on the website.
Client
Server
- Rails
Database
- [Public and private reading lists]
- [Devise for user authentication]
- [Ability to delete books, reading lists and comments ]
- [Admin Users are moderators and have all access]
- [Authenticated users can make reading lists, add books and engage with other users content]
Coming soon
- I have divided each task for tracking progress of the project,
To get a local copy up and running, follow these steps.
In order to run this project you need:
Git
and Ruby
gem install rails
Install this project with:
bundle install
Optional, if you have privacy concerns
- Create a
.env
file with the following content:
POSTGRES_USER=postgres
# If you declared a password when creating the database:
POSTGRES_PASSWORD=YourPassword
POSTGRES_HOST=localhost
POSTGRES_DB=book_shelf_development
POSTGRES_TEST_DB=book_shelf_test
- Add
<% ENV['POSTGRES_PASSWORD'] %>
for your password, then add the rest in a similar way
Create Database (Mandatory)
rails db:create
If you have made a migration then run this command
rails db:migrate
rails db:seed
To run the project, execute the following command:
rails s -p 3000 # # for serving the API on localhost:3000
Run tests
bundle exec rspec
👤 Tracy Musongole
- GitHub: @TracyMuso
- LinkedIn: Tracy Musongole
- Medium: @musongoletracy
- Ability to add star ratings on a book
- Ability to follow users
- Ability to unlike books and reading lists
- Ability to create private book clubs with other users
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
Give a ⭐️ if you like this project!
- Myself
-
How I can install rails?
- You can follow the official guide to install rails. If you have gem installed, you can run
gem install rails
to install rails.
- You can follow the official guide to install rails. If you have gem installed, you can run
-
How I can run this project?
-
How I can run tests?
- After cloning repository, run
bundle
and then runrspec test-file-directory
for a specific file orrspec
to run all the tests.
- After cloning repository, run
This project is MIT licensed.