lorenzoworx/awesomeBookslib

Microverse README Template

📗 Table of Contents

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

📖 [AWESOME LIBRARY]

[Awesome Library] is a simple application with three different sections that displays a list of books and allows you to add and remove books from that list.

🛠 Built With

Tech Stack

Key Features

• Navigation bar to navigate through the application
• Section 1: Library list to see the list of books
• Section 2 : A form to add a book
• Section 3 : Contact section

(back to top)

🚀 Live Demo

For a live demo to our project, follow the link below

• Live Demo Link

(back to top)

💻 Getting Started

Describe how a new developer could make use of your project.

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

Prerequisites

In order to run this project you need:

Setup

• Clone this repository or download the Zip folder:

git clone https://github.com/rivasbolinga/AwesomeBooks-library.git

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

you@your-Pc-name:~$ cd <folder>

Usage

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

Run tests

To track linter errors locally follow these steps:

Download all the dependencies run:

npm install

Track HTML linter errors run:

npx hint .

Track CSS linter errors run:

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

Track JavaScript linter errors run:

npx eslint .

Deployment

• GitHub Pages was used to deploy this website
• For more information about publishing sources, see "About github page"

(back to top)

👥 Authors

👤 Andrea Rivas

• GitHub: @rivasbolinga
• Twitter: @AndreaRivasPal

👤 Okolo Oshoke

• GitHub: @lorenzoworx
• Twitter: @lorenzoworx
• LinkedIn: [Oshoke Okolo]https://www.linkedin.com/in/oshoke-okolo-665208108/)

(back to top)

🔭 Future Features

• [Add a implementation to chose if you have read or not the book]
• [Better style and design]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

🙏 Acknowledgments

I would like to thank - [ Microverse]

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

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