Skip to content

An app, that allows users to add and remove books that they have read and would love not to forget the names

Notifications You must be signed in to change notification settings

Othniel2471/awesome-books

Repository files navigation


Awesome Books

📗 Table of Contents

📖 AWESOME BOOKS

Awesome books This is a simple single app built with html,css and javascript, it eneables users to add books and delete books of their choice.

🛠 Built With

Client

Key Features

-add books -remove books -displays books dynamically from javascript.

(back to top)

💻 Getting Started

Running this project on your computer.

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

-A Git hub account
-Node JS
-Visual Studio Code or any other code editor of your preference
-web browser

Setup

Clone this repository to your desired folder:

Install

To Install this project, follow the steps below:

Install Linters

You can find linters for most of the programming languages, e.g. Rubocop for Ruby or ESLint for JavaScript.

Also, there are many ways you can integrate a linter in your workflow:

-text editor plugin
-GitHub Actions
-GitHub apps

Set up Linters

Note: The npm package manager is going to create a node_modules directory to install all of your dependencies. You shouldn't commit that directory. To avoid that, you can create a .gitignore file and add node_modules to it:

.gitignore

node_modules/

Web Hint

This is a customizable linting tool that helps you improve your site's accessibility, speed, cross-browser compatibility, and more by checking your code for best practices and common errors.

NOTE: If you are using Windows, make sure you initialize npm to create package.json file.

npm init -y
  1. Run
    npm install --save-dev hint@7.x
    
    how to use npm: (https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
  2. Copy .hintrc to the root directory of your project.
  3. Do not make any changes in config files - they represent style guidelines that you share with your team - which is a group of all Microverse students.
  4. Run
    npx hint .
    
  5. Fix validation errors.

A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.

  1. Run

npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x not sure how to use npm? Read this.

  1. Copy .stylelintrc.json to the root directory of your project.

  2. Do not make any changes in config files - they represent style guidelines that you share with your team - which is a group of all Microverse students.

If you think that change is necessary - open a Pull Request in this repository and let your code reviewer know about it. 4. Run npx stylelint "*/.{css,scss}" on the root of your directory of your project.

  1. Fix linter errors.

  2. IMPORTANT NOTE: feel free to research auto-correct options for Stylelint if you get a flood of errors but keep in mind that correcting style errors manually will help you to make a habit of writing a clean code!

Usage

To run the project:

  • After cloning the project, open it in a code editor of your choice.
  • If you're using Vs code you can run with live server by installing the live server extension

(back to top)

👥 Authors

👤 Author - OMAIDU OTHNIEL

👤 Author - MARVIN OTIENO

(back to top)

🔭 Future Features

  • A navigation section
  • A contact page
  • A separate page for the add function and display function

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, kindly leave a comment below and share it with someone who enjoys coding! And also give it star, and follow me on github for more. Keep going!

🙏 Acknowledgments

  • I'd like to thank microverse

(back to top)

📝 License

This project is MIT licensed.

(back to top)

About

An app, that allows users to add and remove books that they have read and would love not to forget the names

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published