Awesome books: plain JavaScript with objects

The projects sets up a repo and prepare it for deplyment using linters. Also, it builds an awesome book website with plain JavaScript

Built With

• Major languages : HTNL, JavaScript
• Technologies used

Live Demo

Getting Started

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

Getting Started

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

Prerequisites

• Node.js installed

Setup

Set-up GitHub Actions

In the first commit of your feature branch create a .github/workflows folder and add a copy of .github/workflows/linters.yml to that folder.

Set-up linters in your local env

# .gitignore
node_modules/

Lighthouse

An open-source, automated tool for improving the quality of web pages. It has audits for performance, accessibility, progressive web apps, SEO and more.

Webhint

1. Run

npm install --save-dev [email protected]

2. Copy .hintrc to the root directory of your project.

3. Run

npx hint .

4. Fix validation errors.

Stylelint

1. Run

npm install --save-dev [email protected] [email protected] [email protected] [email protected]

2. Copy .stylelintrc.json to the root directory of your project.
3. Run npx stylelint "**/*.{css,scss}" on the root of your directory of your project.
4. Fix linter errors.

Install

sudo apt install nodejs

Authors

👤 Mancoba Sihlongonyane

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Festus Enning

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• etc

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