README.md

Awesome Books

📗 Table of Contents

• 📖 About the Project
  • 🧪 Linters And Deployment
  • 🛠 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
• 📝 License

📖 Awesome Books

This Project for individual purpose and it organize your fav books

Awesome Books is just a javascript based simple project

🧪 Linters And Deployment

🛠 Built With

Tech Stack

In this project we used many skills, tech and libraries

Documentation

• HTML

Styling

• CSS

Dynamics And Logics

• JavaScript

Key Features

Following features you should observe

• You can add your fav book
• Yoc can remove it if you loose interest or mood swings

(back to top)

🚀 Live Demo

This link will guide you to my project

• Live Demo Link

(back to top)

💻 Getting Started

For having local file and project you can fork this repo or clone it using git clone https://github.com/PowerLevel9000/Awesome-Books.git And for making changes you you should follow prerequisites

Prerequisites

In order to edit this project you need:

• Any text editor such as note pad and word pad
• A web browser
• Node js installed
• An IDE

Suggested IDE

• Visual studio code I prefer this one 🙃🙃
• Atom
• Sublime
• IntelliJ IDEA
• Visual code

Setup

Clone this repository to your desired folder:

• Open your terminal there (bash cmd powershell run etc...) and run npm i to install node modules

• npm run dev or npm run start this will open project in browser

• If you to edit something edit in src dir and then run in terminal npm run build to build it for production

• Before deployment have some linter check

  • npx stylelint "**/*.{css,scss}" for css and saas file
  • npx eslint . for js files
  • npx hint . for html files

• After fixing error build deploy for production

Install

npm i 

Usage

• Navigation bar using SPA
• Book added to shelf

Run tests

• Check whether your fav book added
• Check your mood swings works 🧑‍🏫😁 according to my project

Deployment

You can deploy this project using:

• for this repo and use git hub pages to deploy it

(back to top)

👥 Authors

👤 Adarsh Pathak

• GitHub: @PowerLevel9000
• Twitter: @PowerLevel9002
• LinkedIn: @Adarsh Pathak

👤 Dilsher Balouch

• GitHub: @DilsherB
• Twitter: @_brilliantMindz
• LinkedIn: @_brilliantMindz

🔭 Future Features

• Add navigation bar
• improve functionality
• improve styling

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page).

(back to top)

⭐️ Show your support

If you like my Project give it a Star ✨🌟

(back to top)

🙏 Acknowledgments

I want to thank Microverse for giving me opportunity to show my skills

(back to top)

📝 License

This project is MIT licensed.

(back to top)