Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xiaofan2406/react-starter-kit
A simple boilerplate for starting new react projects.
https://github.com/xiaofan2406/react-starter-kit
boilerplate hacktoberfest jest react react-router tailwindcss
Last synced: about 1 month ago
JSON representation
A simple boilerplate for starting new react projects.
- Host: GitHub
- URL: https://github.com/xiaofan2406/react-starter-kit
- Owner: xiaofan2406
- License: mit
- Created: 2016-09-21T00:41:44.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-05-03T04:13:58.000Z (over 2 years ago)
- Last Synced: 2024-04-13T09:06:01.741Z (9 months ago)
- Topics: boilerplate, hacktoberfest, jest, react, react-router, tailwindcss
- Language: JavaScript
- Homepage:
- Size: 2.87 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# React Starter Kit
A simple boilerplate for starting new react projects.
[![CI Status][ci-badge]][ci]
[![Coverage Status][coverage-badge]][coverage]
[![Dependencies Status][dependencies-badge]][dependencies]
[ci-badge]: https://github.com/xiaofan2406/react-starter-kit/workflows/Build/badge.svg
[ci]: https://github.com/xiaofan2406/react-starter-kit/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/xiaofan2406/react-starter-kit.svg
[coverage]: https://codecov.io/gh/xiaofan2406/react-starter-kit/branches
[dependencies-badge]: https://img.shields.io/david/xiaofan2406/react-starter-kit.svg
[dependencies]: https://david-dm.org/xiaofan2406/react-starter-kit
## Getting started
```shell
git clone https://github.com/xiaofan2406/react-starter-kit.git
cd react-starter-kit
yarn
yarn dev
```
## Developing
### Built With
- [React Router](https://reactrouter.com/web/guides/quick-start)
- [TailwindCSS](https://tailwindcss.com/)
- [Create React App](https://github.com/facebook/create-react-app)
- [Jest](https://facebook.github.io/jest)
## Commands
##### Development
```shell
yarn dev # start webpack-dev-server with hot reload enabled
yarn format # format all source code with prettier
```
##### Testing
```shell
yarn test # start jest in watch mode
yarn coverage # report coverage
```
##### Production
```shell
yarn build # create a minified production build
yarn start # start a localhost server serving the production build
```
## Project Structure
| Path | Import Alias | Description |
| ------------------- | ------------ | --------------------------------------- |
| **config/** | | Project tooling configurations |
| **src/** | `src` | Project source files |
| src/**assets/** | `assets` | Common static file assets |
| src/**components/** | `components` | App components |
| src/**styles/** | `styles` | Global CSS files |
| src/**utils/** | `utils` | Utility helper functions |
| src/**widgets/** | `widgets` | Share pure presentational UI components |