Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/meryemsanem/bookstore


https://github.com/meryemsanem/bookstore

Last synced: 2 days ago
JSON representation

Awesome Lists containing this project

README

        

# πŸ“— Table of Contents

- [πŸ“— Table of Contents](#-table-of-contents)
- [Bookstore πŸ“š ](#bookstore-)
- [πŸ›  Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [πŸ’» Getting Started ](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [πŸ‘₯ Authors ](#-authors-)
- [πŸ”­ Future Features ](#-future-features-)
- [🀝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [πŸ™ Acknowledgments ](#-acknowledgments-)
- [πŸ“ License ](#license-)

# Bookstore πŸ“š

Bookstore is an application that allows users to do these:

- Display a list of books
- Add a book
- Remove a selected book

## πŸ›  Built With

### Tech Stack

Client

### Key Features

- Add and remove book from the book list
- Comment or edit the selected book

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

- Node.js
- npm

### Setup

Clone this repository to your desired folder:

```sh
git clone [email protected]:meryemsanem/bookstore.git
```

### Install

Install this project with:

```sh
cd bookstore
npm install
```

### Usage

To run the linters, run `npx eslint "**/*.{js,jsx}"` or `npx stylelint "**/*.{css,scss}"` from the root directory of the project.

In the project directory, you can run:

### `npm start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\
You may also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can't go back!**

If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

### Run tests

There are currently no tests in this project.

### Deployment

This project is not currently deployed.

(back to top)

## πŸ‘₯ Authors

πŸ‘€ **Meryem Sanem Küçükbayram**

- GitHub: [@meryemsanem](https://github.com/meryemsanem)
- Twitter: [@msanemkckbayram](https://twitter.com/msanemkckbayram)
- LinkedIn: [Meryem Sanem Küçükbayram](https://www.linkedin.com/in/meryem-sanem-kucukbayram-047a831b5/)

(back to top)

## πŸ”­ Future Features

- **Add categories page**

(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, you can contribute to it. You are also welcome to give it a star on GitHub.

(back to top)

## πŸ™ Acknowledgments

I would like to thank Microverse for teaching and enforcing professional level practices.

(back to top)

## πŸ“ License

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

(back to top)