...
- Install all requirements on your machine
brew install graphvizbrew install imagemagickbrew install firefox(for running cucumber tests)
$ git clone https://github.com/kabisa/books
$ cd books
$ rbenv install `cat .ruby-version` # assuming you use rbenv.
$ bundle install
$ yarn install
$ bin/rails db:setup
$ bin/rails s$ bin/webpack-dev-server- Visit your app at http://localhost:3000.
- Preview the ViewComponents at http://localhost:3000/rails/components
The project comes with a seed.rb which you can use to populate your development environment:
$ bin/rails db:seed [USERS_COUNT=n] [BOOKS_COUNT=m]
$ bin/rails ci
To update the diagram, run the following command:
$ bin/rails erd
Since I never used Material Design before, I thought this project would make a good candidate. For this I used Daemonite's Material UI, which uses Bootstrap with some customizations added to it. Instructions on how to use Daemonite's Material UI in a Rails project can be found here.
Font Awesome has a gem available for including FA in a Rails project. Instead this project used yarn for installing the FA package, since relies on the asset pipeline.
I did copy the view helper from this gem and renamed it from icon to fa_icon
The production version of this application uses SendGrid for sending mails.
In some environments images are uploaded to an S3 bucket using CarrierWave. If you want to use this feature, make sure you have an S3 bucket created and add the required keys to the corresponding ENV variables:
AWS_ACCESS_KEY_IDAWS_SECRET_ACCESS_KEYAWS_REGIONAWS_BUCKET_NAME
Generated using https://dummyimage.com/200x300/212121/fafafa.png&text=No+Cover+Available
The application is hosted by Heroku (staging and production). Instruction about the deployment process can be found here.
