GithubHelp home page GithubHelp logo

zero-to-mastery / book-tracker Goto Github PK

View Code? Open in Web Editor NEW
102.0 20.0 320.0 4.63 MB

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

Home Page: https://zero-to-mastery.github.io/book-tracker/

License: MIT License

HTML 15.93% JavaScript 26.43% CSS 57.65%

book-tracker's Introduction

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.

Book Tracker

Project Thumbnail

Description

The Amazing Book Tracker is a web-based application created by students from the Zero To Mastery Academy.

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 and NPM should be installed.

Clone the repository

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

Install dependencies

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:

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

Contributions are very welcome, please view the Code of Conduct.

Add yourself to the List of Contributors 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.

License

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

Acknowledgements

Favicons

React App Favicon: Icon by Freepik on flaticon.com, and made with realfavicongenerator.net.

book-tracker's People

Contributors

aditya1906 avatar alexacoronel avatar bryamedic25 avatar charlottenewcomer avatar chasewri avatar d4rkm3z avatar dependabot[bot] avatar dromediansk avatar drood87 avatar edfilbasan avatar falghi avatar gillenha avatar iphyokafor avatar iqbalhussainkhan avatar kennithnichol avatar kristian383 avatar l-white avatar leslielopez25 avatar mattcsmith avatar naveen-ku avatar paolaarz avatar phat-marc avatar samirjouni avatar software-trizzey avatar sophiabrandt avatar srividyakk avatar thetaungg avatar thomas-lysens avatar ttyson0311 avatar virtueandterror avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

book-tracker's Issues

textarea issue

When typing a book's name, then delete it, which can not delete the first letter. have to reload the page to clean it.

CONTRIBUTING.md needs review

The file named CONTRIBUTING.md has some information that should rather be placed in the readme.md file, and other information that should be opened as issues. To solve this I suggest that:

  1. The first 2 sentences, which are concerned with guidelines, be moved to the readme.md file under a heading called: Guidelines, perhaps consider subheadings as well.
  2. The following 3 paragraphs which all relate to issues, should be reviewed and, where relevant and necessary, new issues for each problem should be opened. Perhaps follow these steps:
    2.1 Read paragraph and split up into individual issues.
    2.2 Check each issue to make sure it is indeed a problem
    2.4 Open new issue with relevant info and a suggested path to solve the problem.

React App needs a favicon

Grab a nice book icon from any free icon site, i.e., fontawesome or flaticon, and create a favicon using a site such as realfavicongenerator.net

Add the favicon to public/index.html and public/manifest.json by swapping out with the original react favicon.

Sizes should be 512, 256, 192, 32, and 16px.

Page structure & functionality

Hey,

I'd like to contribute more to this project, but I'd like to know if there is a particular direction the owners would like the project to go? At the moment it's not very clear what kind of functionality the page should have, i.e., what should appear on the wish list, reading list, homepage, where do the books added go, etc.

Thanks!

Dependency Security Issues

According to Dependabot there has been a few security alerts regarding dependancies in yarn.lock

The following are:

  • minimist
  • acorn
  • kind-of
  • lodash

Sorted by severity level.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.