Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nsdonato/boilerplate_vitetsreact

Boilerplate Vite
https://github.com/nsdonato/boilerplate_vitetsreact

eslint husky lintstaged prettier react reactrouterdom reacttestinglibrary tailwindcss vite

Last synced: 17 days ago
JSON representation

Boilerplate Vite

Awesome Lists containing this project

README

        

# Boilerplate Vite

You can download this template to avoid setting up a project from scratch with the technologies mentioned below.

## Authors

- [@nsdonato](https://www.github.com/nsdonato)

## Features ✨

- [Babel](https://babeljs.io/) with [preset-env](https://babeljs.io/docs/en/babel-preset-env)
- [Prettier](https://prettier.io/)
- [ESLint](https://eslint.org/) with:
- [Simple Import Sort](https://github.com/lydell/eslint-plugin-simple-import-sort/)
- [Import plugin](https://github.com/benmosher/eslint-plugin-import/)
- And a few other ES2015+ related rules
- [Husky](https://github.com/typicode/husky)
- [Lint Staged](https://github.com/okonet/lint-staged)
- [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
- [React](https://reactjs.org/)
- [TypeScript](https://www.typescriptlang.org/)
- [Tailwind](https://tailwindcss.com/)
- [React Router](https://reactrouter.com/docs/en/v6/getting-started/overview)
- [Jest](https://jestjs.io) with [DOM Testing Library](https://testing-library.com/docs/dom-testing-library/intro)
- [GitHub Actions](https://github.com/features/actions)

## Run Locally

Clone the project

```bash
git clone https://github.com/nsdonato/boilerplate_vitetsreact
```

Go to the project directory

```bash
cd boilerplate_vitetsreact
```

Install dependencies

```bash
npm install
```

Start the server

```bash
npm run dev
```

To run tests, run the following command

```bash
npm run test
```

If you have problems running tests on mac: https://github.com/facebook/draft-js/issues/2183

## GitHhub Actions Pipeline

- ✋🏼 Cancel Previous Redundant Builds
- 📝 Assign PR to creator
- 💅🏼 Linting
- 👷🏻‍♀️ Build
- 🧐 Testing

## Feedback

If you have any feedback, please reach out to us at [email protected]

## 🔗 Links

[![twitter](https://img.shields.io/badge/twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/vamoacodear)