Gardimy/Awesome_books

Awesome books

A Microverse exercise to use animation on a website

Awesome books

📗 Table of Contents

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

📖Aweesome books

In this project, I build a basic website that allows users to add/remove books from a list. I achieve that by using JavaScript objects and arrays. I also dynamically modify the DOM and add basic events.. The use of linters to ensure code quality follows the Javascript best practices.

🛠 Built With

Tech Stack

This project focuses only on linters and .gitignore. and JS or Server are included in this repo.

Client

• HTML
• SCSS
• JavaScript

Server

• Netlify

Key Features

• Linters: Lighthouse, Webhint, and Stylelint
• A .github/workflows/linters.yml file to run linters on GitHub Pull Request.
• A .gitignore file including node_modules/. -Eslintnpm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x [ -f .eslintrc.json ] || wget https://raw.githubusercontent.com/microverseinc/linters-config/master/html-css-js/.eslintrc.json - name: ESLint Report

(back to top)

💻 Getting Started

If you are a new developer and would like to have a basic project to start practicing your code or creating your first portfolio app-features using good practice JavaScript ,HTML and CSS : Cloning this project will give you what you need!

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

Prerequisites

In order to run this project you need:

• Have npm installed in your project: curl -qL https://www.npmjs.com/install.sh | sh

Setup

Clone this repository to your desired folder:

https://github.com/Gardimy/Awesome_books

or

https://github.com/Gardimy/Awesome_books <-- Only if you have SSH keys configured on your GitHub account.

Install:

run the npm install command in your console.

Usage

To run the linters before committing any changes to your code, execute the following commands:

npx hint . npx stylelint "**/*.scss" <--NOTE: this repo is set up to use with SCSS. If you would like to use CSS, you must replace "**/*.scss" with "**/*.{css,scss}" in line 48 of the .stylelintrc.json file, and run the linter with:

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

(back to top)

👥 Authors

👤 Gardimy Charles

• GitHub: @Gardimy
• Twitter: @gardyelontiga45
• LinkedIn: Gardimy charles

🔭 Future Features

• ESLint.

⭐️ Show your support

If you like this project please give me a star on GitHub.And Don't hesitate to follow me on github, you will have the opportunity to get all updating available for this project.

🙏 Acknowledgments

I would like to thank microverse for teaching me this Skills

📝 License

This project is MIT license licensed.

(back to top)