Microverse README Template

📗 Table of Contents

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

📖 Awesome-Books

Awesome Books App is an online bookshelf built with plain JavaScript.

🛠 Built With

Tech Stack

Client

• HTML5
• CSS3
• JavaScript

Key Features

• Responsive Design.
• Pixel Perfect design.
• Saving data to Local Storage

(back to top)

🚀 Live Demo

• Here is the link to the live experience.

	Mobile version	Desktop version

(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:

• A web browser to view output e.g Google Chrome.
• An IDE e.g Visual studio code.
• A terminal.

Setup

Clone this repository to your desired folder or download the Zip folder:

git clone https://github.com/AdnanOlarmmi/Awesome-Books.git

• Navigate to the location of the folder in your machine:

you@your-Pc-name:~$ cd Awesome-Books

Install

Install all dependencies:

npm install

Usage

To run the project, follow these instructions:

• After Cloning this repo to your local machine.
• Open the index.html in your browser.

Run tests

To run tests, run the following command:

• Track HTML linter errors run:

npx hint .

• Track CSS linter errors run:

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

• Track JavaScript linter errors run:

npx eslint .

Deployment

You can deploy this project using: GitHub Pages,

• I used GitHub Pages to deploy my website.
• For more information about publishing sources, see "About GitHub pages".

(back to top)

👥 Authors

👤 Is-haq, Adnan Olamilekan

• GitHub: @AdnanOlarmmi
• Twitter: @AdnanIshaqOla
• LinkedIn: Adnan (Olamilekan) Is-haq

👤 Anye Peter Chendi

• GitHub: @anyepeter
• Twitter: @anyepeter
• LinkedIn: @PeterChendi

(back to top)

🔭 Future Features

• Implement button to switch sort type (ascending or descending alphabetically).
• Implement Responsiveness by adding burger menu

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project and how I managed to build it!

(back to top)

🙏 Acknowledgments

• The original design ideal from Microverse💕.
• Project from Microverse JavaScript module.
• Thanks to the Microverse team for the great curriculum.
• Images inspired by Freepik on Flaticon
• Thanks to the Code Reviewer(s) for the insightful feedbacks.
• A great thanks to My coding partner(s), morning session team, and standup team for their contributions.
• Hat tip to anyone whose code was used.

(back to top)

❓ FAQ

• Can I fork and reuse the repository

  • Yes please, feel free.

• Can I improve the repository, and my changes will be accepted if they are good?

  • Yes please, nice ideas are welcome, please.

(back to top)

📝 License

This project is MIT licensed.

(back to top)