rmiyoyo/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.

Awesome Books Project

Awesome Books Project

📗 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
• 📝 License

📖 Awesome Books Project

Awesome books is a simple website that displays a list of books and allows you to add and remove books from that list. Main objective is to implement data management in JavaScript.

🛠 Built With

• HTML.
• CSS.
• JavaScript
• LINTERS.

Tech Stack

Client

• HTML
• CSS
• JavaScript

Key Features

• Use of medium-fidelity wireframe to build the UI.
• Customized for both mobile and desktop devices.
• Navigation and Animations

(back to top)

🚀 Live Demo

• The live demo is coming soon.

(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 Chrome browser
• npm

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:rmiyoyo/Awesome-Books.git

Install

Install the prerequisites this project using:

  cd awesome-books
  npm init -y
  npm install --save-dev hint@7.x
  npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x

Usage

To run the project:

index.html

Run tests

To run tests after setting up the linters, run the following command:

  npx hint .

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

Deployment

You can deploy this project using:

• Run index.html on your preferred browser.

(back to top)

👥 Authors

👤 Raphael Miyoyo

• GitHub: @rmiyoyo
• Twitter: @r_miyoyo
• LinkedIn: LinkedIn

👤 Paing Soe Thu

• GitHub: @K0ppai
• Twitter: @koppai
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Add CSS
• Deploy to Github Pages

(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 this project, create a pull request or hit us up on Raphael's Twitter or Koppai's Twitter for any other thing.

(back to top)

🙏 Acknowledgments

• Thank you for code reviews and pull requests!

(back to top)

📝 License

• This project is MIT licensed.
  

(back to top)