Skip to content

ndurivin/Light-Reader

Repository files navigation

README

Light-Readers Web App

By Verah Kwamboka, Johnson Bidura, Sharon Wangari, & Vincent Nduri

Screenshot

image

Table of Content

Description

This project is a web application for Light-Readers, an online book library that offers its users unlimited access to books at their comfort, provided they are registered. Unregistered users; however, have a limited access of up to three (3) books. The app gives its users access to different books online, which otherwise would not be accessible to them in hard copies.

Go Back to the top

Features

As a user of the application,you will be able to

  1. View & read a limited (3) books as an unregistered user.
  2. Sign up & login into the system for full access to all available books.
  3. Read books and write reviews for each book read.

Go Back to the top

Requirements

  • Access to a computer, a laptop or any other garget
  • Access to internet

Installation Process


  • Clone to this repo : git clone https://github.com/ndurivin/Light-Reader
  • Unzip the downloaded files in a folder of choice.
  • Ensure that your gadget has all the necessary installations for running a react frontend, rails backend, & postgresql database application.
  • Open the files in a code editor of choice and in the terminal run 'bundle install', followed by 'npm install --prefix client' to install all the necessary dependencies needed to successfully run the application.
  • To get the app running online, get to the terminal within the directory and run 'rails s' to load the rails backend and in another terminal window, run 'npm start --prefix client' to load the react frontend of the application.

Go Back to the top

Live Link

Technologies Used

  • BOOTSTRAP - used in creating the mobile-first-view responsiveness
  • JAVASCRIPT - which was used for writing manipulation scripts and app interactivity in react.
  • REACT JS LIBRARY - which was used to build the frontend user interface.
  • RUBY ON RAILS - which was used to build the backend that contains cocre functionality & feeds data to the app's frontend.
  • POSTGRESQL - which is used to build the database that stores the app's core data

Go Back to the top

Known Bugs

Licence

MIT License Copyright (c) [2022] [Verah, Sharon, Johnson, & Vincent] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Go Back to the top

Authors Info

Github Profiles - Verah Kwamboka Johnson Bidura Saron Wangui Vincent Nduri

LinkedIn - Verah Kwamboka Johnson Bidura Sharon Wangari Vincent Nduri Go Back to the top

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •