Awesome Books

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 Books 📖

Awesome Books is a simple website that displays a list of books and allows you to add and remove books from that list.

---

Built With 🛠

Tech Stack 🗜️

Client

• HTML5 markup to build raw structure of this web page


• CSS3 custom properties, FlexBox, Grid to make the website visually attractive


• Javascript


• Linters for coding convention and coding formating

Javascript runtime environment

• Node JS as a javascript runtime machine [git], a free and open source distributed version control system

Deployement

• GitHub Pages

---

Key Features 🏷️

• Manage books collection
• Remove Books
• Add Books

(back to top)

---

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:

• A Github account
• Node JS
• A web browser to view output e.g Microsoft Edge.
• An IDE e.g Visual studio code.
• A terminal.

---

Setup ⚙️

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/RileyManda/awesome-books.git

• Navigate to the folder

cd my-folder

• Checkout the branch

git checkout main

---

Install 🏗️

Install all dependencies:

    npm install

---

Usage 📂

To run the project, follow these instructions:

• You have to clone this repo to your local machine.

git clone https://github.com/RileyManda/awesome-books.git

---

Run tests 🧪

How should it be tested? To run tests, run the following command:

• HTML linter errors run:

npx hint . --fix

• CSS linter errors run:

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

• JavaScript linter errors run:

npx eslint . --fix

• For unit testing, run:

npm test

---

Deployment

You can deploy this project using: GitHub Pages, Vercel or Netlify.

This project was deployed using GitHub Pages. For more information about how to use GitHub pages read here 🤩. If you want to watch a video about how to use GitHub pages instead of reading click here ☺️.

(back to top)

---

👥 Authors

Mention all of the collaborators of this project.

👤 Nelly Telli

• GitHub: @lily4178993
• Twitter: @nelly_telli
• LinkedIn: Nelly T.

👤 Riley Manda

• GitHub: @RileyManda
• Twitter: @rilecodez
• LinkedIn: rileymanda

(back to top)

---

Future Features 🔭

• Add a new book to the collection
• Display all books saved in the collection
• Remove a book from the collection

(back to top)

---

Contributing 🤝

If you have suggestions 📝, ideas 🤔, or bug reports 🐛, please feel free to open an issue on GitHub. Remember, every contribution, no matter how big or small, makes a difference.

(back to top)

---

Show your support 🌟

Thank you for taking the time to explore our GitHub project! Your support means a lot to us. If you find our project valuable and would like to contribute, here are a few ways you can support us:

• Star the project ⭐️: Show your appreciation by starring this GitHub repository. It helps increase visibility and lets others know that the project is well-received.

• Fork the project 🍴 🎣: If you're interested in making improvements or adding new features, feel free to fork the project. You can work on your own version and even submit pull requests to suggest changes.

• Share with others 🗺️: Spread the word about this project. Share it on social media, mention it in relevant forums or communities, or recommend it to colleagues and friends who might find it useful.

(back to top)

---

Acknowledgments 🙏

We would like to express our sincere gratitude to Microverse, the dedicated reviewers, and collaborarors. Your unwavering support, feedbacks, and collaborative efforts have played an immense role in making this journey a resounding success. Thank you for being an integral part of our achievements.

(back to top)

---

FAQ ❓

• Question_1 Do I have to use the vs code specifically?
  • Answer_1 You can use any code editor of your choice.
    
• Question_2 Where can I download node JS for installation?
  • Answer_2 Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine. It can be downloaded here: https://nodejs.org/en/download/Node.jsNode.js

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