masumajaffery / awesome-books

Awesome-Books facilities users to add and remove Books! This Web App Made with Best Practices of HTML, CSS and JS.

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 webpage that facilates end-users to add and remove Books.

🛠 Built With

Tech Stack

HTML+CSS+JS+GITHUB

Technologies

• Html
• CSS
• Javascript
• GitHub

Key Features

• [Adaptability]
• [Performance]

(back to top)

Prerequisites

In order to run this project you need the following tools:

• Node installed in your computer
• IDE(e.g.: Vscode,...)
• HTML-CSS-JS-GitHub
• etc.

Setup

Clone this repository to your desired folder:

Example commands:

  cd my-folder
  git clone [email protected]:MasumaJaffery/Awesome-Books.git

Install

• Install project's packages with:

   cd Awesome-Books
  npm install or npm i

Usage

To run the project, execute the following command:

Open index.html using live server extention.

Run Tests

To run tests, run the following command:

Track HTML linter errors run: npx hint .

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

👤 Syeda Masuma Fatima

• GitHub: @MasumaJaffery
• Twitter: @MasumaJaffery
• LinkedIn: Masuma Jaffery

(back to top)

🔭 Future Features

• [Add More Functionality]
• [Add Features]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

(back to top)

⭐️ Show your support

If you like this project, I would like to Thank You!

(back to top)

🙏 Acknowledgments

Special Thanks to Microverse!

(back to top)

📝 License

This project is MIT licensed.

(back to top)

awesome-books's Issues

Peer to peer code review

Good job so far @MasumaJaffery ✔✔✨✨

• I think it should be better if you Improve the Indentation in JS Files to avoid Eslint Errors. Please kindly consider this recommendation.

Happy coding. 👍👍✨✨

Peer to peer code review

Hi @MasumaJaffery ,

Good job so far! ✔✔
Congratulations! 🎉 🎉

Highlights 🎉

✅ Linters tests passing.
✅ Correct use of GitHub Flow.
✅ Great project design! 🎯
✅ All requirements addressed. 💯
✅ Incorporates feedback from previous code reviews.

Cheers and Happy coding!👏👏👏

Optional Requirements:
-Your js code is clear and readable, good job.

• I think it would be great if you use fewer comments.