book-tracker - GitLite

KO | EN

gitlite — search

#hacktoberfest #typescript #llm #golang #rust #deep-learning #linux #nodejs #java #awesome #vue #security #mcp #openai

book-tracker

(★ 100)

"Tracks the amount of books that you've read, the ones you want to read and the progress on the ones you're reading."

File Explorer

Download Latest Version (.zip)

- CONTRIBUTORS_20200203122703.md
- CONTRIBUTORS_20200203124804.md
- - .env.template
  - .gitignore
  - package-lock.json
  - package.json
  - server.js
- debug.log
- index.html
- readingList.html
- script.js
- - apple-touch-icon.png
  - browserconfig.xml
  - favicon-16x16.png
  - favicon-32x32.png
  - mstile-150x150.png
  - original_icon_image.svg
  - safari-pinned-tab.svg
  - site.webmanifest
- android-chrome-192x192.png
- android-chrome-384x384.png
- favicon.ico
- index.html
- manifest.json
- - background.jpg
- - App.css
  - App.js
  - HomePage.js
  - WishListPage.js
- - auth.service.js
  - default-books.service.js.js
  - signUp.service.js
- index.css
- index.js
- registerServiceWorker.js
- - book-tracker-icon.png
  - book.jpeg
- index.html
- login.css
- login.html
- main.css
- newsletter.html
- register.html
- script.js
- script2.js
.editorconfig
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
CONTRIBUTORS.md
debug.log
LICENSE
package-lock.json
package.json
README.md
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/zero-to-mastery/book-tracker

Downloads the entire project code from GitHub to your computer.

cd book-tracker

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## **UPDATE: This repository is archived. We are no longer accepting contributions.**

**If you'd like to contribute to other Zero to Mastery projects, please take a look at our other [open-source projects](https://github.com/zero-to-mastery).**

# Book Tracker

![Project Thumbnail](https://i.ibb.co/yhzRCG5/amazing-book-tracker-preview.jpg)

## Description

**The Amazing Book Tracker** is a web-based application created by students from the [Zero To Mastery Academy](https://zerotomastery.io/).

The goal of the app is to provide users with a means to manage their book collections.

End users can record the books they've previously read, books they want to read; as well as the books they're currently reading.

## Functionality

Users should be able to sign up as new members by filling out a registration form.

After joining, they should be able to log in as an existing user.

Users should be able to add a book to the system.

Users should be able to place books on 3 separate lists:

1. Books they've already read
2. Books they want to read
3. Books they are currently reading.

Finally, users should be able to easily navigate through these separate lists.

## Getting Started

### Prerequisites

[NodeJS](https://nodejs.org/en/) and [NPM](https://www.npmjs.com/) should be installed.

### Clone the repository

```sh
git clone https://github.com/zero-to-mastery/book-tracker.git
```

### Install dependencies

```sh
cd book-tracker
npm install
```

### Start development

_There are 2 versions of the app, one made with vanilla JavaScript, one made with React._

#### React Version

To start the development server for the React version:

```sh
npm start
```

The frontend app will be running on `localhost:3000`.

#### JavaScript Version

All the files are located in `vanilla_js_site`.

Open `index.html` in the browser or if using VS Code the Live Server extension is recommended.

## Contributing

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

Contributions are very welcome, please view the [Code of Conduct](CODE_OF_CONDUCT.md).

Add yourself to the [List of Contributors](CONTRIBUTORS.md) and submit a pull request if you've contributed.

**Working on your first Pull Request?** Learn how from this in-depth series: [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github).

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

# Acknowledgements

## Favicons

React App Favicon: Icon by Freepik on flaticon.com, and made with [realfavicongenerator.net](https://realfavicongenerator.net/).