AndreaM2429 / Awesome_books

Basic website that allows users to add/remove books from a list

Awesome Books

Awesome Books

📗 Table of Contents

• 📗 Table of Contents
• 📖 [Awesome Library]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Awesome Library

Awesome Library is the project to save the data of every book in local storage of browser using ES6.

Note: this is a copy from the repo that I contributed. Here is the link to the repo where you can see my contributions.

🛠 Built With

1. HTML
2. CSS
3. Bootstrap
4. JavaScript
5. Linters

Tech Stack

MarkUp

• HTML
• md files

Style

• CSS

Dynamic

• JavaScript

Key Features

• Responsive
• Local Storage Usage
• Deployed
• ES6
• Luxon
• Arrow functions

(back to top)

🚀 Live Demo

• ✅ You can see the live demo of this webpage by clicking here;

(back to top)

💻 Getting Started

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

1. Download or clone this repostory.
2. Provide a browser.
3. Open the index.html file using webpage browser.

Prerequisites

In order to run this project you need:

• Git installed in your machine.
• Sign in or sign up to your Github account.
• A professional editer such as VS Code.
• An Updated web browser such as Google Chrome, you can download it from here.
• Node.js installed in your machine.
• Lighthouse.
• Webhint

npm init -y
npm install --save-dev hint@7.x
npx hint .

• Stylelint

npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x

• ESLint

npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x

Setup

• Clone this repository to your desired folder:

• Example commands:

  cd [YOUR FOLDER]
  git clone https://github.com/AndreaM2429/Awesome_books

Install

• Install this project by cloning or downloading the master branch of this repository and run index.html file on the root of repository.

Usage

• To run the project, execute the following command:

 cd [YOUR FOLDER]
 git clone https://github.com/AndreaM2429/Awesome_books

Run tests

1. WebHint

npx hint .

2. Stylelint

npx stylelint "**/*.{css,scss}"

To fix errors automatically

npx stylelint "**/*.{css,scss}" --fix

3. ESLint

npx eslint .

To fix errors automatically in an specific file

npx eslint --fix paht.js

To fix errors automatically in all files

npx eslint --fix .

Deployment

This project is deployed by the author, no permission for deployment by any other client.

(back to top)

👥 Authors

👤 Andrea Manuel

• GitHub: @AndreaM2429
• Twitter: @twitter
• LinkedIn: LinkedIn

Past collaborators

👤 Mohammad Anwar Hussaini

• 👤 GitHub: @Anwar Hussaini
• 👤 Twitter: @MAnwarHussaini
• 👤 LinkedIn: Mohammad Anwar Hussaini

(back to top)

🔭 Future Features

• [Client interaction]
• [Tutorials]

(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 drop a start for the repository;

(back to top)

🙏 Acknowledgments

I would like to thank the following individuals and organizations for their contribution to this project.

• 🙏 Microvere for its arrangement and supports to all Micronauts and me.

(back to top)

📝 License

This project is MIT) licensed.

(back to top)