Skip to content

A twitter-like web application to suggest books and impression on them between friends

Notifications You must be signed in to change notification settings

pacyL2K19/books-helper

Repository files navigation

Ruby On Rails Capstone Project - Books Helper

This project is a Books helper based on Twitter Web App that allows users to share opinions on a specific book made in Ruby On Rails

screenshot Live Demo

GET STARTED

Requirements

  • At least one code editor installed (VS Code for example)
  • Git installed
  • Ruby installed
  • At least one web browser

Clone the repository

  • Click on the "code" button above on this page and copy the link to the repository
  • Run git clone git@github.com:pacyL2K19/books-helper.git
  • Go to the cloned repository run cd books-helper

Install required Gem and Node packages

  • In the terminal, run
    $ bundle install
    
  • [optional] Run
    $ bundle update
    
  • Install node packages nun
    $ yarn install --check-files
    

Set up the database tables

  • In ./config/database.yml file, update the username and the password by yours
  • Run rails db:create and make sure the commande succeded
  • Run rails db:migrate and make sure the commande succeded

Test all in the browser

  • Run $ rails server
  • In the browser go to http://127.0.0.1:3000/
  • This page should display (for the first loading)
  • screenshot
  • Create a new user by putting informations inside the text fields and importing images for the profile and the cover (Not mandatory)
  • After loging in, this main screen should display
  • Suggest any book and here we go ...
  • Follow any user on the right-side menu

Run the tests

$ rails db:migrate RAILS_ENV=test
$ rspec --format documentation

🤝 Contributing

Contributions, issues and feature requests are welcome following a correct gitflow workflow !

Acknowledgments 🤝

A special thanks to Gregoire Vella for this project, which took guidance on his project idea. The original page to check is here.

Authors

👤 Pacifique Linjanja

About

A twitter-like web application to suggest books and impression on them between friends

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published