Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/barackm/book-opinions
This project is a Ruby on Rails capstone project based on a redesign of Twitter. Built with Rails
https://github.com/barackm/book-opinions
Last synced: 15 days ago
JSON representation
This project is a Ruby on Rails capstone project based on a redesign of Twitter. Built with Rails
- Host: GitHub
- URL: https://github.com/barackm/book-opinions
- Owner: barackm
- Created: 2021-06-17T08:48:55.000Z (over 3 years ago)
- Default Branch: development
- Last Pushed: 2022-08-26T21:01:53.000Z (about 2 years ago)
- Last Synced: 2023-03-07T16:04:44.181Z (over 1 year ago)
- Language: HTML
- Homepage: https://b-book-reviewer.herokuapp.com/
- Size: 5.04 MB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project: Book Reviewer
> This project is a Ruby on Rails capstone project based on a redesign of Twitter. It is a place where people can share opinions or reviews about books with people who follow them. Reviews can be commented on and voted on so that other users may be confident about posted reviews.
## Screenshots
## Live demo
You can visit the deployed version of the app via [this link](https://b-book-reviewer.herokuapp.com/sessions/new)
## Built With
- Ruby on rails
## Getting Started
To get a local copy up and running follow these simple example steps:
- Clone the repository as indicated by Setup section below
### Prerequisites
- Text editor
- GitHub
- Git
- ruby
- ruby on rails
### Setup
Clone repository from github to your local drive by following these steps:
- Go to the main page of the repository
- Above the listed files, click the green Code button
- You can clone the repository using:
- GitHub CLI: gh repo `$ git clone github.com/barackm/book-opinions `.
- SSH:`$ git clone [email protected]:barackm/book-opinions.git`.
- HTTPS:`$ git clone https://github.com/barackm/book-opinions `.
- Open Terminal
- Change the current working directory to the location you want the cloned directory
- Type one of the git clone commands listed above.
- Press Enter to create your local clone
- Remember: Yarn packages need to be installed by running the command yarn install for local setup. Otherwise, the app generates an error.
- Install all the available gems with the command `bundle install`
- Create a database by typing in the terminal rails db:create and then rails db:migrate to define changes to your database schema
- For webpacker we need to run the command `rails webpacker:install`
- Open your terminal and type rails s. After that join to localhost at `http://localhost:3000/`
- Feel free to sign up or sign in and start posting!
### Install
- Install Atom or Microsoft Visual Studio text editor to view the code on your local machine.
- Install Git.
- Install ruby
- Install ruby on rails
### Tests
- This project includes unit tests and integration tests, to run the tests you will just need to run the following command in the terminal from the root of the project
`$ rails db:migrate RAILS_ENV=test`
`$ rspec --format documentation`
## Author
👤 **Barack Mukelenga**
- GitHub: [@barackm](https://github.com/barackm)
- Twitter: [@BarackMukelenga](https://twitter.com/BarackMukelenga)
- LinkedIn: [Barack Mukelenga](https://www.linkedin.com/in/baraka-mukelenga/)
## Contributing
Contributions, [issues](https://github.com/barackm/book-opinions/issues), and feature requests are welcome!
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- Microverse
- [Gregoire Vella](https://www.behance.net/gregoirevella) for the design inspiration.