Skip to content

Use React Router to refactor original Library project from Week 12

Notifications You must be signed in to change notification settings

andeewarren/BookNook-library

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

logo

BookNook Personal Library

A great web app for keeping track of the books you own and want to read!

contributors last update commits open issues


📔 Table of Contents

🌟 About the Project

📷 Screenshots

screenshot

screenshot screenshot

👾 Tech Stack

Client

🎯 Features

  • Include genre and whether the book has been read
  • See books marked as "to be read"

🎨 Color Reference

Color Hex
Primary Color #263342 #263342
Secondary Color #E4E5E7 #E4E5E7
Accent Color #685C71 #685C71
Text Color #FEFFF7 #FEFFF7 and #263342 #263342

🧰 Getting Started

‼️ Prerequisites

This project uses Node.js as package manager

 npm install -g npm

⚙️ Installation

Install my-project with npm

  npm install my-project
  cd my-project

🧪 Running Tests

To run tests, run the following command

  npm test

🏃 Run Locally

Clone the project

  git clone https://github.com/andeewarren/BookNook-library.git

Go to the project directory

  cd my-project

Install dependencies

  npm install

Start the server

  npm start

👀 Usage

Use this app to keep a digital record of books owned, with information such as the author and grnre, as well as if it's been read.

🧭 Roadmap

  • Add ability to sort by title, author or genre
  • Create collections for more than TBR

👋 Contributing

Contributions are always welcome!

❔ FAQ

  • Why did you decide to build this app instead of something different?

    • I love collecting books but my memory isn't that great, so it's difficult when I'm at the bookstore and can't always remember if I own this book or I've read that book. Having a digital library keeps track of that for me. I also haven't found a similar app that I like for various reasons. The entry is always tedious, but I'd like to at least have something nice to look at while I work.
  • What are your plans for this app in the future?

    • I want to add more functionality to the book list. I'd like to be able to sort and filter, as well as edit a book directly from its entry rather than deleting it and starting over. I'd also love to develop this into a mobile app once I have the knowledge.

🤝 Contact

Andee Warren - @LinkedIn

Project Link: https://github.com/andeewarren/BookNook-library

💎 Acknowledgements

Use this section to mention useful resources and libraries that you have used in your projects.

About

Use React Router to refactor original Library project from Week 12

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published