A web application that gives users the ability to search, view and add books to their library. A book can only be in 4 states as shown below. The first 3 listed below are counted as being in a user's Library.
- Read (Finished)
- To Be Read (Not started)
- Currently Reading
- Not in Library
The user can quickly interact with the books, either through the books's main page or through the cards that show up when a book is searched.
Built mainly with TypeScript and SASS. I employed the concepts of web components to build reuseable components for the project.
I have deployed the website on Vercel.
This section gives a rundown on how to set this project up locally to begin development.
This section assumes that you have NodeJS and npm installed on your local system.
-
Clone the repo
git clone https://github.com/kosiumeigbo/book-tracker-library.git cd book-tracker-library/client -
Install NPM packages
npm install
-
Create a
.envfile with the variables according to the same format in the.env.examplefile. -
You can get your API Keys from the following resources: NYT Developer and Google Books API
-
Run the local server in client
npm run start
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Kosidinna Umeigbo - Twitter
Project Repo: Book Tracker Library
Project Website: Website
I have listed below a few resources that have been helpful to me while developing this project.