Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/krenbot/book-nook

A bibliophile's dream app to help categorize books you love and trash books you don't.
https://github.com/krenbot/book-nook

bookshelf-app express expressjs javascript nodejs

Last synced: 26 days ago
JSON representation

A bibliophile's dream app to help categorize books you love and trash books you don't.

Awesome Lists containing this project

README 

        
# -**Book||Nook**- 
 A Virtual Bookshelf For the Modern Era



## Description



A bibliophile's dream app that lets users create and maintain a virtual bookshelf. Add books paired with critical reviews and user comments to get the most out of your social reading experience. Users can sign up to maintain their own personal shareable library to track the books they're currently reading, want to read, and have read.



Share your personal takes on both the contemporary and classics only with **__Book||Nook__**!



## Table of Contents

- [Installation](#installation)

- [Usage](#usage)

- [Badges](#badges)

- [Features](#features)

- [Credits](#credits)

- [License](#license)



## Installation



BookNook can be found deployed on Heroku at the following link: 

=> [Book||Nook](https://book-nook.herokuapp.com/login) <= 



## Usage



Within the app, you are able to add books you've read, read popular reviews, and add your own comments.



Visiting the site for the first time allows users to login or sign up.

![login](./assets/login.png)



This page is your personal shelf of books.

![main page](./assets/main-page.png)

![shelf page](./assets/shelf-page.png)



Clicking on a book reveals it's reviews, title, author, ISBN #, number of pages, and comments.

![book page](./assets/book-page.png)



The user can read critical reviews and place their own comments

![main page](./assets/reviews-comments.png)



## Badges



![badmath](https://img.shields.io/github/languages/top/lernantino/badmath)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)

![MIT](https://img.shields.io/badge/license-MIT-green)



## Features

- Adding/Deleting Books

    - Create your own virtual bookshelf to share with others.




- Commenting

    - Add notes/ideas/quotes, etc to save for your reference or share with friends.




- Reviews

    - Browse popular reviews or add your own!




- Social

    - Customize your own shelf and link up with friends to talk about what you've read/want to read/have read.



## Credits

[@Pharos19](https://github.com/Pharos19) - Alan Martinez


[@Krenbot](https://github.com/Krenbot) - Steven Krenn


[@JeremyBukofzer](https://github.com/JeremyBukofzer) - Jeremy Bukofzer


[@OilPainter1](https://github.com/OilPainter1) - Henry Cryns


[@kevinkraiss](https://github.com/kevinkraiss) - Kevin Kraiss



[anime.js](https://animejs.com/)


[Handlebars.js](https://bulma.io/)



___

## License



MIT License



Copyright (c) 2022


Steven Krenn/Kevin Kraiss/Jeremy Bukofzer/Alan Martinez



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.

___

## How to Contribute



### Contributor Covenant Code of Conduct



#### Our Pledge



We as members, contributors, and leaders pledge to make participation in our

community a harassment-free experience for everyone, regardless of age, body

size, visible or invisible disability, ethnicity, sex characteristics, gender

identity and expression, level of experience, education, socio-economic status,

nationality, personal appearance, race, caste, color, religion, or sexual

identity and orientation.



We pledge to act and interact in ways that contribute to an open, welcoming,

diverse, inclusive, and healthy community.



#### Our Standards



Examples of behavior that contributes to a positive environment for our

community include:



* Demonstrating empathy and kindness toward other people

* Being respectful of differing opinions, viewpoints, and experiences

* Giving and gracefully accepting constructive feedback

* Accepting responsibility and apologizing to those affected by our mistakes,

  and learning from the experience

* Focusing on what is best not just for us as individuals, but for the overall

  community



Examples of unacceptable behavior include:



* The use of sexualized language or imagery, and sexual attention or advances of

  any kind

* Trolling, insulting or derogatory comments, and personal or political attacks

* Public or private harassment

* Publishing others' private information, such as a physical or email address,

  without their explicit permission

* Other conduct which could reasonably be considered inappropriate in a

  professional setting



#### Enforcement Responsibilities



Community leaders are responsible for clarifying and enforcing our standards of

acceptable behavior and will take appropriate and fair corrective action in

response to any behavior that they deem inappropriate, threatening, offensive,

or harmful.



Community leaders have the right and responsibility to remove, edit, or reject

comments, commits, code, wiki edits, issues, and other contributions that are

not aligned to this Code of Conduct, and will communicate reasons for moderation

decisions when appropriate.



#### Scope



This Code of Conduct applies within all community spaces, and also applies when

an individual is officially representing the community in public spaces.

Examples of representing our community include using an official e-mail address,

posting via an official social media account, or acting as an appointed

representative at an online or offline event.



### Enforcement



Instances of abusive, harassing, or otherwise unacceptable behavior may be

reported to the community leaders responsible for enforcement at

[INSERT CONTACT METHOD].

All complaints will be reviewed and investigated promptly and fairly.



All community leaders are obligated to respect the privacy and security of the

reporter of any incident.



### Enforcement Guidelines



Community leaders will follow these Community Impact Guidelines in determining

the consequences for any action they deem in violation of this Code of Conduct:



### 1. Correction



**Community Impact**: Use of inappropriate language or other behavior deemed

unprofessional or unwelcome in the community.



**Consequence**: A private, written warning from community leaders, providing

clarity around the nature of the violation and an explanation of why the

behavior was inappropriate. A public apology may be requested.



### 2. Warning



**Community Impact**: A violation through a single incident or series of

actions.



**Consequence**: A warning with consequences for continued behavior. No

interaction with the people involved, including unsolicited interaction with

those enforcing the Code of Conduct, for a specified period of time. This

includes avoiding interactions in community spaces as well as external channels

like social media. Violating these terms may lead to a temporary or permanent

ban.



### 3. Temporary Ban



**Community Impact**: A serious violation of community standards, including

sustained inappropriate behavior.



**Consequence**: A temporary ban from any sort of interaction or public

communication with the community for a specified period of time. No public or

private interaction with the people involved, including unsolicited interaction

with those enforcing the Code of Conduct, is allowed during this period.

Violating these terms may lead to a permanent ban.



### 4. Permanent Ban



**Community Impact**: Demonstrating a pattern of violation of community

standards, including sustained inappropriate behavior, harassment of an

individual, or aggression toward or disparagement of classes of individuals.



**Consequence**: A permanent ban from any sort of public interaction within the

community.



## Attribution



This Code of Conduct is adapted from the [Contributor Covenant][homepage],

version 2.1, available at

[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].



Community Impact Guidelines were inspired by

[Mozilla's code of conduct enforcement ladder][Mozilla CoC].



For answers to common questions about this code of conduct, see the FAQ at

[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at

[https://www.contributor-covenant.org/translations][translations].



[homepage]: https://www.contributor-covenant.org

[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

[Mozilla CoC]: https://github.com/mozilla/diversity

[FAQ]: https://www.contributor-covenant.org/faq

[translations]: https://www.contributor-covenant.org/translations