mcraepv / librar.io

Librar.io is a book search and journaling app that allows users to find and save their favorite novels and keep entries as they read them.

Librar.io

Live Site

https://mcraepv.github.io/librar.io/

Description

Librar.io allows users to create and save book journals of their favorite novels, and search the google books API to find new ones! Users can then keep a reading journal to help them stay motivated. Users can also find links to where to buy the books their search queries return.

Installation

Clone our repository to check out the code, or visit the live site above to see it deployed.

Usage

Try out the search, or add a book you're currently reading to the journal section.

Credits

Foundation

https://get.foundation/

jQuery

https://jquery.com/

Google Books API

https://developers.google.com/books

Firebase

https://firebase.google.com/

Font Awesome

https://fontawesome.com/

License

MIT License

Copyright (c) 2020 Charles McRae Peavy & Mina Ghaffar

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.

Developers

Charles McRae Peavy

LinkedIn

https://www.linkedin.com/in/mcraepv/

Github

https://github.com/mcraepv

Mariam Ghaffar

LinkedIn

https://www.linkedin.com/in/mariam-ghaffar-22852957/

Github

https://github.com/mghaffar89

librar.io's Issues

WHEN I choose a book

THEN I am presented with a link to purchase options

Create base files and push to master branch

WHEN I go to find books

THEN I am presented with a choice of entering criteria or taking a quiz

come up with quiz ideas

set up book search - backend

configure search quiz page

edit readme

GIVEN I want to keep track of my reading progress

WHEN I create a new item in the "My Books" section
THEN I can add the book I'm reading

come up with MVP

configure book search page

add tech components (jQuery, Materialize)

switched framework to Foundation for ease of use

WHEN I click the new item

THEN I am presented with a pages/day tracker and a journal (with dates)

WHEN I click an option

THEN I am taken to that option

WHEN I complete my chosen search method

THEN I am given accurate Results

GIVEN I am a new or experienced reader

WHEN I enter the app
THEN I am presented with a clean, simple interface

research apis

load diary entries by user from firebase firestore

store diary entry data by user data in firebase

add basic layout