Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://mailsg.github.io/__Awesome-Books__/

"Awesome books" is a simple website that displays a list of books and allows to add and remove books from that list. It demonstrates how to manage data using JavaScript. A medium fidelity wireframe is used to build the UI.
https://mailsg.github.io/__Awesome-Books__/

Last synced: 12 days ago
JSON representation

"Awesome books" is a simple website that displays a list of books and allows to add and remove books from that list. It demonstrates how to manage data using JavaScript. A medium fidelity wireframe is used to build the UI.

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 Awesome Books

**Awesome Books** is a web app that shows information about books.

## 🛠 Built With

### Tech Stack

HTML/CSS/JavaScript

GitHub

### Key Features

- **Home Page**
- **Add/Remove Books Page**
- **Update Books Page**
- **Time**

(back to top)

## 🚀 Live Demo

[Live Link](https://mailsg.github.io/__Awesome-Books__/)

(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 browser
- git
- nodejs

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone [email protected]:mailsg/Awesome-Books.git
```

### Install

Install this project with:

```sh
cd my-project
npm install
```

### Usage

To run the project, execute the following command:

```sh
Open index.html in browser
or
Open with Live server in Vscode
```

### Run tests

To run tests, run the following command:

```sh
npx stylelint "**/*.{css,scss}"
npx hint .
npx eslint .
```

(back to top)

## 👥 Author

👤 **Sandeep**

- GitHub: [@mailsg](https://github.com/mailsg)

(back to top)

## 🔭 Future Features

- [ ] **Profile Section**
- [ ] **News Section**
- [ ] **Join Section**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [https://github.com/mailsg/__Awesome-Books__/issues](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project give me a follow and/or a star

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse for giving this opportunity to me to showcase my dev skills.

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)