An open API service indexing awesome lists of open source software.

https://github.com/rysth/webpack-template


https://github.com/rysth/webpack-template

Last synced: over 1 year ago
JSON representation

Awesome Lists containing this project

README

          

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [Future Features](#future-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Test](#test)
- [👥 Authors](#authors)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 ES6 Awesome Books App

**ES6 Awesome Books App** description....

## 🛠 Built With

### Tech Stack

Client

### Key Features

- Add new books with their title and author.
- Display a list of saved books.
- Remove books from the list.
- Store book data using `localStorage`.

(back to top)

### Future Features

- **Implement a CSS Preprocessor.**
- **Implement a Database**

(back to top)

## 🚀 Live Demo

### Take a Look

- [Live Demo Link](https://rysth.github.io/ES6-Awesome-Books/)

(back to top)

## 💻 Getting Started

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

### Setup

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

1. Clone the repository: `git clone https://github.com/RysthCraft/ES6-Awesome-Books.git`
2. Navigate to the project directory: `cd ES6-Awesome-Books`
3. Install the dependencies: `npm install`
4. Build the project: `npm run build`
5. Open `index.html` in your web browser.

Then, you will change everything you want!

### Test

In order to follow the Linters you could check them using this:

```
HTML Checker:
npx hint .

CSS Checker:
npx stylelint "**/*.{css,scss}"

JavaScript Checker:
npx eslint .
```

#### Note

Use at the end '--fix' to help you out with any error.

## 👥 Authors

👤 **Rysth**

- GitHub: [@rysth](https://github.com/RysthCraft)
- Linkedin: [@johnpalacios](https://www.linkedin.com/in/john-palacios-rysth/)

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project feel free to watch it and take some features that will enhance your project
as well.

(back to top)

## 🙏 Acknowledgments

I would like to thank the Microverse Team for reviewing my code and making me a better
professional.

(back to top)

## 📝 License

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

(back to top)