https://github.com/epilande/yaris
:rocket: Yet Another React Isomorphic Starter
https://github.com/epilande/yaris
boilerplate code-splitting isomorphic react redux server-side-rendering styled-components universal webpack
Last synced: 19 days ago
JSON representation
:rocket: Yet Another React Isomorphic Starter
- Host: GitHub
- URL: https://github.com/epilande/yaris
- Owner: epilande
- License: mit
- Created: 2016-07-14T03:51:56.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-10-25T21:03:12.000Z (over 6 years ago)
- Last Synced: 2025-03-26T10:52:17.212Z (about 1 month ago)
- Topics: boilerplate, code-splitting, isomorphic, react, redux, server-side-rendering, styled-components, universal, webpack
- Language: JavaScript
- Homepage: https://yaris-selhchnzyh.now.sh/todo
- Size: 1.73 MB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# YARIS
**Yet Another React ~~Isomorphic~~ Universal Starter**
[](https://travis-ci.org/epilande/yaris)
[](https://codecov.io/gh/epilande/yaris)
[](https://greenkeeper.io/)
[](https://david-dm.org/epilande/yaris)
If you don't want Universal JavaScript, check out my other boilerplate **[YARS](https://github.com/epilande/yars)**.
## Features
- [X] Server-Side Rendering
- [X] Webpack v2
- [X] React
- [X] React HMR
- [X] React Redux
- [X] React Router (async routes)
- [X] React storybook
- [X] Babel
- [X] Styled-components
- [X] Jest and Enzyme
- [X] ESLint
- [X] Stylelint
- [X] NPM Scripts
## Quick Start
#### Clone this repo
```bash
$ git clone https://github.com/epilande/yaris.git
$ cd yaris
```
#### Install dependencies
```bash
$ npm install # or yarn
```
#### Launch dev environment
```bash
$ npm run dev
```
## Available Commands
|`npm run `|Description|
|------------------|-----------|
|`dev`|Starts app on `localhost:3000` in development mode with HMR enabled.|
|`start`|Starts `./public/server.js`, which has production bundles.|
|`build`|Runs `build:prod` & `build:server` to create production bundles.|
|`build:prod`|Creates **client** bundle with production environment.|
|`build:server`|Creates **server** bundle with production environment.|
|`lint`|Lints `./src/**/*.js` & `./server/**/*.js` with eslint & stylelint.|
|`test`|Runs unit tests with Jest & generates coverage report.|
|`test:watch`|Same as `npm run test`, but watches for changes to re-run tests.|
|`storybook`|Starts `react-storybook` on `localhost:9001`.|
## Structure
**Feature-first** approach, all of the related files are in one place.
```
src/
├── components/ // Shared or generic UI components
│ ├── A/
│ ├── Button/
│ │ ├── test/
│ │ │ ├── index.test.js // Tests for component
│ │ ├── index.js // The actual Button component
│ │ ├── index.stories.js // This gets picked up by react-storybook
│ ├── Footer/
│ └── ...
├── containers/
│ └── FeaturePage/
│ ├── components/ // All FeaturePage specific components live here
│ │ ├── List/
│ │ ├── ListItem/
│ │ ├── ListItemTitle/
│ │ │ └── index.js
│ │ └── ...
│ ├── actions.js
│ ├── constants.js
│ ├── index.js
│ ├── reducer.js
│ └── ...
```