Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sunny250984/react-boilerplate
https://github.com/sunny250984/react-boilerplate
Last synced: 30 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/sunny250984/react-boilerplate
- Owner: sunny250984
- License: mit
- Created: 2024-10-29T01:57:40.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-10-29T01:58:33.000Z (4 months ago)
- Last Synced: 2024-11-13T13:08:58.439Z (3 months ago)
- Language: JavaScript
- Size: 645 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Why do I want this?
As you probably know, there are numerous boilerplates available for [React](https://facebook.github.io/react/), so you might be wondering why you would want to use ours. Most of the boilerplate projects come with a lot of code that you rarely need. Our boilerplate was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app) and provides you with a great starting point for any React project with as few lines of code as possible, especially if you want to use [Flowtype](https://flowtype.org/).
## What do I need to get started?
- [Node](https://nodejs.org/en/download/) (version 6 or later)
- [Yarn](https://yarnpkg.com/lang/en/docs/install/)
## What's in the box?
- [Flowtype](https://flowtype.org/) Type checker
- [React](https://facebook.github.io/react/) User interface components
- [MobX](https://mobx.js.org/) Simple, scalable state management
- [Lodash](https://lodash.com/) Utility library
- [Babel](https://babeljs.io/) JavaScript transpiler
- [ESLint](http://eslint.org/) JavaScript Linter
- [Prettier](https://github.com/prettier/prettier) Code formatter
- [PostCSS](http://postcss.org/) CSS transformer
- [Stylelint](https://stylelint.io/) CSS Linter
- [Webpack](https://webpack.js.org/) Module bundler
- [Jest](https://facebook.github.io/jest/) Testing solution
## How do I use this?
You can find our documentation [here](./docs/README.md).
## Usage
### Create project
Install [create-project](https://www.npmjs.com/package/create-project) and create your project.
```bash
yarn global add create-project
create-project my-project sunny250984/react-boilerplate && cd my-project
```
### Install dependencies
Install the project dependencies using Yarn.
```bash
yarn
```
### Create the environment
Create your environment by copying the example environment.
```bash
cp .env.example .env
```
### Development server
You can start the development server with the `start` script.
```bash
yarn start
```
### Distribution build
You can compile the distribution build with the `build` script.
```bash
yarn build
```
## Test
### Test suite
You can run the test suite with the `test` script.
```bash
yarn test
```
## License
[MIT](LICENSE)