https://github.com/umarluqman/ra
https://github.com/umarluqman/ra
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/umarluqman/ra
- Owner: umarluqman
- License: mit
- Created: 2021-08-21T04:52:13.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-08-21T04:52:14.000Z (almost 5 years ago)
- Last Synced: 2025-02-17T08:34:26.152Z (over 1 year ago)
- Language: TypeScript
- Size: 6.84 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ReactTS 17 with Chakra UI and Vite
This is a [React](https://reactjs.org) + [TypeScript](https://www.typescriptlang.org/) + [Chakra UI](https://chakra-ui.com) boilerplate to be built with [Vite](https://vitejs.dev). It also includes [Husky](https://typicode.github.io/husk) and a pre-commit hook that runs `yarn format`.
## What's inside?
- [ReactJS](https://reactjs.org)
- [Vite](https://vitejs.dev)
- [TypeScript](https://www.typescriptlang.org)
- [Chakra UI](https://chakra-ui.com)
- [Framer Motion](https://www.framer.com/motion/)
- [Jest](https://jestjs.io)
- [Testing Library](https://testing-library.com)
- [Eslint](https://eslint.org)
- [Prettier](https://prettier.io)
- [Husky](https://typicode.github.io/husky)
\+ other smaller dependencies
## Getting started
1. Create the project.
```bash
npx degit The24thDS/vite-reactts17-chakra-jest-husky my-app
```
2. Access the project directory.
```bash
cd my-app
```
3. Initialize a git repository.
```bash
git init
```
4. Install dependencies.
```bash
yarn
```
5. Serve with hot reload at http://localhost:3000.
```bash
yarn dev
```
## Recommended VS Code extensions
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
- [vscode-styled-components](https://marketplace.visualstudio.com/items?itemName=jpoissonnier.vscode-styled-components)
## Other commands
### Lint commands
- Run eslint
```bash
yarn lint
```
- Run eslint with fixing
```bash
yarn lint:fix
```
### Build commands
```bash
yarn build
```
### Test commands
- Run tests with coverage (will open the coverage if all tests succeed)
```bash
yarn test
```
- Watch tests
```bash
yarn test:watch
```
## License
This project is licensed under the MIT License.