Skip to content

chantommyy/Re-readr

Repository files navigation

Re:readr

Live demo here

Table of Contents

About the project

With Re:readr, you can swap books you've finished reading for ones you're interested in 📚 Signing up for an account is all it takes to get started. Simply enter the book's ISBN code, upload it on the website and swap it for a book you like. The platform was built in just two weeks.

How it works:

  • Register an account
  • Enter the ISBN of your book to upload it on the platform
  • Search for available books
  • Send a swap request for the book you like
  • Swap your book once your request is approved
  • Leave a review

Features

Adding a book with ISBN:

ezgif com-gif-maker (6)

Sending a swap request:

mobile (1)

Accepting a swap request:

ezgif com-crop (1)

Leaving a review:

ezgif com-crop (2)

Tech Stack

Re:readr is optimized for use on all devices, but for the best viewing experience, we recommend using a mobile device.

Frameworks & libraries used:

Version control & deployment

Installation

To run our app locally, you will need to have already installed Yarn and Rails. Check them with:

$ yarn -v 
$ rails --version

If no version number is returned, please install Yarn and/or Rails before continuing.

Dependencies

You'll also need to install all dependencies of the project with:

$ bundle install && yarn install

The bundle command installs all Ruby Gems specified in our Gemfile. The yarn install command retrieves all dependencies from the project’s package.json file.

Run the following command to create a database, load the schema, and initialize it with our seed data.

$ rails db:create db:migrate db:seed

Launch🚀

Launch the app by running:

$ rails s
$ yarn build --watch

Then go to localhost:3000

How to contribute

Feel free to fork our repo and create a pull request with any changes you'd like to see us incorporate. We are open to suggestions🙂

  • Fork the Project
  • Create your Feature Branch (git checkout -b feature/AmazingFeature)
  • Commit your Changes (git commit -m 'Add some AmazingFeature')
  • Push to the Branch (git push origin feature/AmazingFeature)
  • Open a Pull Request

License

Created as part of the Le Wagon Full Stack Web Development bootcamp. Feel free to fork and enhance the platform.

The team

Made with love by:

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •