https://sonickmumba.github.io/Awesome-Books-ES6/

"Awesome books" is a simple website that displays a list of books and allows you to add and remove books from that list. This UI is built using a medium-fidelity wire frame, use ES6 modules to write modular JavaScript.
https://sonickmumba.github.io/Awesome-Books-ES6/

css es6 eslint html javascript stylelint

Last synced: 10 days ago
JSON representation

"Awesome books" is a simple website that displays a list of books and allows you to add and remove books from that list. This UI is built using a medium-fidelity wire frame, use ES6 modules to write modular JavaScript.

• Host: GitHub
• URL: https://sonickmumba.github.io/Awesome-Books-ES6/
• Owner: Sonickmumba
• Created: 2022-08-15T10:05:59.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-08-17T12:41:23.000Z (over 2 years ago)
• Last Synced: 2024-10-24T16:38:20.162Z (4 months ago)
• Topics: css, es6, eslint, html, javascript, stylelint
• Language: JavaScript
• Homepage:
• Size: 248 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![](https://img.shields.io/badge/Microverse-blueviolet)

# Awesome Books: with ES6

> In this project, I restructure my Awesome books app code. The goal is to make it more organized by using modules. I will also practice the ES6 syntax that I have learned, Use ES6 modules to write modular JavaScript and Use npm as software packages system.

## Built With

- HTML and CSS

- Frameworks: N/A

- Technologies used: GIT, GITHUB, LINTERS

- npm

- Luxon library

## Live Demo

Check **Live Demo** [here.](https://sonickmumba.github.io/Awesome-Books-ES6/)

## Getting Started

> To get a local copy up and running follow these simple example steps.

### Prerequisites

- npm (node package manager) – to be able to install packages locally.

- A github Account – to be able to use github actions.

### Setup

- Open the terminal.

- Run cd \path\to\where\you\want\your\local\copy

- Clone the repo

   i. Run [email protected]:Sonickmumba/My-Portfolio.git

   ii. Run cd README/

### Install

- install Webhint linter

    i. Run npm install --save-dev [email protected]

- install Stylelint linter

    i. Run npm install --save-dev [email protected] [email protected] [email protected] [email protected]

- install ESLint linter

    i. Run npm install --save-dev [email protected] [email protected] [email protected] [email protected]

- install gulp

    i. Run touch gulpfile.js

    ii. Run npm install gulp --save-dev

    iii. Run npm install gulp-autoprefixer --save-dev

### Usage

### Run tests

- run Webhint linter

    - Run npx hint . on the root of your directory of your project.

- run Stylelint linter

    - Run npx stylelint "**/*.{css,scss}" on the root of your directory of your project.

- run ESLint linter

    - Run npx eslint . on the root of your directory of your project.

- run gulp

    - Run gulp  on the root of your directory of your project.

### Deployment

To run the project open the downloaded folder (after extraction) then run the "**index.html**" file in your browser.

## Authors

👤 **Author1**

- GitHub: [@Sonickmumba](https://github.com/Sonickmumba)

- Twitter: [@Sonick](https://twitter.com/MumbaSonick)

- LinkedIn: [Sonick Mumba](https://www.linkedin.com/in/sonick-m-301557a2/)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

## Show your support

Give a ⭐️ if you like this project!

## 📝 License

This project is [MIT](./MIT.md) licensed.