Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dyarawilliams/book-up
Bookup: Your Library in the Clouds is an online book management system that you can use to keep track of books you've read or want to read. As a member, you can add books and authors to our API.
https://github.com/dyarawilliams/book-up
ejs express mongodb nodejs rest-api sass
Last synced: about 2 months ago
JSON representation
Bookup: Your Library in the Clouds is an online book management system that you can use to keep track of books you've read or want to read. As a member, you can add books and authors to our API.
- Host: GitHub
- URL: https://github.com/dyarawilliams/book-up
- Owner: dyarawilliams
- Created: 2021-05-05T23:46:57.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-10T17:15:49.000Z (6 months ago)
- Last Synced: 2024-07-10T22:55:58.516Z (6 months ago)
- Topics: ejs, express, mongodb, nodejs, rest-api, sass
- Language: CSS
- Homepage: https://bookup.onrender.com/
- Size: 18.2 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Book Up
## Introduction
Bookup offers a one-stop destination for book lovers to discover, explore, and engage with a vast array of titles. With personalized recommendations, user-generated content, and a seamless browsing experience, Bookup enhances the journey of book discovery and fosters a vibrant community around literature.
Book-up helps you to redefine the way you experience literature. If you sign up you can submit a book or author, if not you can search and view the books and authors listed.
## Objective
- Comprehensive Database: Develop a robust database of books across various genres, encompassing both popular and niche titles.
- User-Friendly Interface: Create an intuitive and visually appealing platform that allows users to easily search, discover, and explore books.
- Personalization: Implement features for personalized book recommendations based on user preferences, reading history, and ratings.
- Community Engagement: Foster a vibrant community where users can share reviews, recommendations, and engage in discussions about books.
## Who is this for?
Bookup aims to cater to book enthusiasts of all ages and backgrounds, including avid readers, students, educators, book clubs, and casual readers seeking their next literary adventure.
## Application Features and Description
- Search and Browse: Users can search for books by title, author, genre, or keyword. They can also explore curated lists and featured titles.
- Personalized Recommendations: The platform utilizes algorithms to suggest books based on users' reading preferences, history, and ratings.
- User Profiles: Users can create profiles to track their reading progress, maintain wishlists, and share reviews and ratings with the community.
- Community Interaction: Users can engage in discussions, participate in book clubs, and share their favorite reads with others.
- Book Details: Each book page provides comprehensive details, including synopsis, author information, reader reviews, and related titles.
- Bookshelf Organization: Users can organize their virtual bookshelves, categorizing books they've read, want to read, or are currently reading.
- Notifications: Users receive updates on new releases, personalized recommendations, and community activities.
- Accessibility: The platform is designed to be accessible to users with disabilities, with features such as screen reader compatibility and high contrast mode.
## Getting Started
# Tools and Resources
- Frontend: HTML, CSS, JavaScript
- Backend: Node.js, Express.js, MongoDB
- Version Control: Git for collaboration and version control
- UI/UX Design: Adobe XD, Figma, or Sketch for wireframing and prototyping
- Testing: Jest for unit testing, Selenium for end-to-end testing
- Deployment: Render
### Dependencies
(prerequisites, libraries, OS version, etc needed before installing the program)
A few necessary are express, ejs, express-ejs-layouts, mongoose, body-parser
* [NPM Packages](https://github.com/dyarawilliams/book-up/blob/main/package.json) : sass
### Installing
* How/where to download your program - [ZIP](https://github.com/dyarawilliams/book-up/archive/refs/heads/main.zip) - OR
```bash
git clone https://github.com/dyarawilliams/book-up.git
```
* Modifications that need to be made to files/folders - add a .env file to ```/config``` that contains
```env
DB_STRING=
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
```
### Executing program
* You can run the program by opening your terminal to the book-up root folder and entering
```
npm i
npm run dev
```
* In another terminal run Sass Compiler to update the CSS file ```styles.css```
```
npm run compile:sass
```
## Help
Any advice for common problems or issues?
## Authors
[D'yara WIlliams](https://dyarawilliams.github.io)
## Contributors names and contact info
No current contributors
## Version History
* 1.0
* Initial Release
## License
This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details
## Acknowledgments
Will be listing a few acknowledgments in the future
