https://github.com/launchpadlab/bookwrm
Master repo for bookwrm app developed as part of the ChickTech high school kick-off
https://github.com/launchpadlab/bookwrm
Last synced: 7 months ago
JSON representation
Master repo for bookwrm app developed as part of the ChickTech high school kick-off
- Host: GitHub
- URL: https://github.com/launchpadlab/bookwrm
- Owner: LaunchPadLab
- Created: 2018-09-14T16:07:27.000Z (over 7 years ago)
- Default Branch: dev
- Last Pushed: 2018-10-19T16:28:28.000Z (over 7 years ago)
- Last Synced: 2025-04-09T19:55:42.083Z (10 months ago)
- Language: Ruby
- Size: 513 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BOOKWRM
Welcome to bookwrm, the social book review app! In this app you will be able to register and log in as a user,
view a collection of books, and read or leave reviews for individual books.
This app is developed with Ruby on Rails, and deployed on Heroku at #TODO - Heroku Link
## Getting Started
### Prerequisites
+ Ruby 2.4.4
+ Rails 5.2.1
+ Postgres 9.6
### Setup the App
+ Fork the repo to your github account
+ `git clone git@github.com:YOUR-USERNAME/bookwrm.git`
+ `cd bookwrm`
+ update `application.yml`, `database.yml`
### Running in Development
+ `bundle install`
+ `bundle exec rake db:create db:migrate db:seed`
+ `rails s`
+ open `localhost:3000`
### Deployment
+ Sign up for Heroku at `https://signup.heroku.com/`
+ Create a new app at `https://dashboard.heroku.com/new-app`
+ Connect the app to this GitHub repository
+ Deploy the `master` branch through `Manual deploy`
+ Click on `Open App` in the top right corner of the page, and view the app in the browser!
### References
+ [Ruby](https://www.ruby-lang.org/en/)
+ [Rails](https://rubyonrails.org/)
+ [Devise](https://github.com/plataformatec/devise)
+ [Heroku](https://www.heroku.com/)