README.md

Awesome Books: with ES6

📗 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

📖 Awesome Books

Awesome Books Re-build Awesome Books to use ES6.

🛠 Built With

Tech Stack

Client

• HTML
• SCSS
• JavaScript

Server

• GitHub Pages

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

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

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:

git clone https://github.com/astroboyReloaded/Hello-Microverse.git

or

git clone git@github.com:astroboyReloaded/Hello-Microverse.git <-- 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:

lighthouse <url>

npx hint .

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

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

npx stylelint "**/*.scss"

instead.

npx eslint .

(back to top)

👥 Authors

👤 AstroboyReloaded

• GitHub: @astroboyReloaded
• Twitter: @astroboyReload
• LinkedIn: Alex Muñoz

🔭 Future Features

• Saved message.
• Option to save several books or go to Collection page after saving one book.

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like this project please give me a star on GitHub.

🙏 Acknowledgments

I would like to thank Microverse for teaching me these tools.

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)