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 (OPTIONAL)
• 📝 License

📖 Awesome-books

Describe your project in 1 or 2 sentences.

[Awesome Books] is the project where the code for the Awesome Books app is reorganized. The objective is to use modules and practice ES6 syntax to make it more structured.

🛠 Built With

Tech Stack

Client

• HTML

• CSS

• JAVASCRIPT

Key Features

• Add the linter for the project to fix the errors and clean the codeok_hand
• User-friendly Interface: Simple and intuitive interface for a seamless user experience.rocket
• Style the text using the CSS 100

(back to top)

🚀 Live Demo

Coming Soon

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

• Visual Studio
• Github
• git

Setup

Clone this repository to your desired folder:

Example commands:

git clone git@github.com:https://github.com/sharminkhan0/Awesome-books.git

Install

Install this project with:

• please first install the node package files
  • npm install

Usage

To run the project, execute the following command:

• In order to use this project you create branch to add more feature.
• But in order to run the project use below commands
  • npm run build (It will create a production ready file)
  • npm start (It will run the server on your machine)

Run tests

To run tests, run the following command:

I have added linters or tests in order to avoid typos and ensure good practice in this project.So while using this repository if you need to check your work no matters have worked on html, css and js you can use below commands

• In order to run the linter test on index.html or any html file. use below command npx hint .

• To run linter test on stylesheets. Use below command npx stylelint "**/*.{css,scss}"

Deployment

You can deploy your project using github free source.

(back to top)

👥 Authors

👤 Sharmin Akter Khan

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [add more interactive buttons and sections]
• [style it beautifully]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Please feel free to contribute to this project if you enjoy it, and don't forget to star the repository so that it may be seen by more people.

(back to top)

🙏 Acknowledgments

As well as Freecodecamp and w3school for their useful articles that assisted me in creating this project, I would like to thank Microverse for their innovative approach to teaching me how to code.

(back to top)

📝 License

This project is MIT licensed.

(back to top)