ntimanu / awesome-books

awesome-books

Awesome Books

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support -- 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 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

Key Features

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

Tech stack

The project is built using the following technologies:

• Frontend:
  • HTML
  • Css
  • 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 [email protected]
     

     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. Run

     npx hint .
     

  4. Fix validation errors.

  Stylelint

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

  1. Run

  npm install --save-dev [email protected] [email protected] [email protected] [email protected] not sure how to use npm? Read this.

  2. Copy .stylelintrc.json 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.

  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.

  5. Fix linter errors.

  6. 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 - ADEBAYO ADEDOYIN

  • GitHub: (https://github.com/shabiblac)
  • Twitter: (https://twitter.com/@shabi_blacc)
  • LinkedIn: ( https://www.linkedin.com/in/shabi-adebayo-019186187/)

  (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.

  (back to top)

awesome-books's Issues

Peer-to-peer review

• All work looks great
• Descriptive commit massage
• code is clean