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

https://github.com/thenameiswiiwin/bookshelf

This is a React + Vite app to be used with Tailwindcss.
https://github.com/thenameiswiiwin/bookshelf

Last synced: 3 months ago
JSON representation

This is a React + Vite app to be used with Tailwindcss.

Awesome Lists containing this project

README

          

# React Tailwindcss Application build with Vite

This is a [ReactJS](https://reactjs.org) + [Vite](https://vitejs.dev) application to be used with [Tailwindcss](https://tailwindcss.com).

## What is inside?

This project uses many tools like:

- [ReactJS](https://reactjs.org)
- [Vite](https://vitejs.dev)
- [TypeScript](https://www.typescriptlang.org)
- [Jest](https://jestjs.io)
- [Testing Library](https://testing-library.com)
- [Tailwindcss](https://tailwindcss.com)
- [Eslint](https://eslint.org)
- [Prettier](https://prettier.io)
- [ReachUI](https://reach.tech/)

API:
- [Google Books APIs](https://developers.google.com/books)

## Getting Started

### System Requirements

- [git][git] v2.13 or greater
- [NodeJS][node] `14.10+ || 16+`
- [npm][npm] v6 or greater || [yarn][yarn]

All of these must be available in your `PATH`. To verify things are set up
properly, you can run this:

```bash
git --version
node --version
yarn --version || npm --version
```

### Setup

Clone the project.

```bash
git clone https://github.com/thenameiswiiwin/bookshelf.git
```

Access the project directory.

```bash
cd bookshelf
```

Install dependencies.

```bash
yarn || npm install
```

Serve with hot reload at .

```bash
yarn dev || npm run dev
```

### Lint

```bash
yarn lint || npm run lint
```

### Build

```bash
yarn build || npm run build
```

### Test

```bash
yarn test || npm run test
```