Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/freddykaberuka/book-store


https://github.com/freddykaberuka/book-store

Last synced: 26 days ago
JSON representation

Awesome Lists containing this project

README

        

Micro Library Web App

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 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)
- [📝 License](#license)

# 📖 [Micro-Library]

> is a website for Kepping a Books(BookStore)

> Make simple calculations.
> Read a random math-related quote.

**[Micro-Library]** is a website which used to store a books

## 🛠 Built With

### Tech Stack

> Describe the tech stack and include only the relevant sections that apply to your project.

Client

### Key Features

> the added feature is Books with it category

- **[Add Books]**
- **[List Books]**

(back to top)

## 💻 Getting Started

> this is a website for all Reader of different books. and it's allows users to:

> to store a different Books
> To get a list of Books

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/freddykaberuka/mocro-library.git
```

### Install

Install this project with:

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

### Usage

To run the project, execute the following command:

```sh
npm start
```

### Run tests

To run tests, run the following command:

```sh
npm run test
```

### Deployment

You can deploy this project using:

```sh
npm run build
```

(back to top)

## 👥 Authors

> Mention all of the collaborators of this project.

👤 **Author1**

- GitHub: [@githubhandle](https://github.com/freddykaberuka)
- Twitter: [@twitterhandle](https://twitter.com/trojanx07)
- LinkedIn: [LinkedIn](https://linkedin.com/in/kaberuka-freddy-853b08153/)

(back to top)

## 🔭 Future Features

> we will be having a Book store web app for keeping the different books with it's category.

- [ ] **[Add a book]**
- [ ] **[view a List of books]**
- [ ] **[add categories to a book]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

> If you like this project fell free to contribute.

(back to top)

## 🙏 Acknowledgments

> I would like to thank Microverse for the guidance on this project.

(back to top)

## 📝 License

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

(back to top)