https://github.com/lnked/react-starter

React Starter Kit
https://github.com/lnked/react-starter

linters mobx postcss pwa react react-router-v4 react-starter-kit styled-components tests typescript webpack4

Last synced: 2 months ago
JSON representation

React Starter Kit

• Host: GitHub
• URL: https://github.com/lnked/react-starter
• Owner: lnked
• License: mit
• Created: 2017-01-29T00:03:55.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-02-09T23:01:07.000Z (almost 3 years ago)
• Last Synced: 2024-10-22T22:46:04.980Z (3 months ago)
• Topics: linters, mobx, postcss, pwa, react, react-router-v4, react-starter-kit, styled-components, tests, typescript, webpack4
• Language: JavaScript
• Homepage: https://lnked.github.io/react-starter
• Size: 59.1 MB
• Stars: 13
• Watchers: 1
• Forks: 2
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![license](https://img.shields.io/github/license/lnked/react-starter.svg)](https://github.com/lnked/react-starter/blob/fastest/LICENSE)

[![Build Status](https://travis-ci.org/lnked/react-starter.svg?branch=master)](https://travis-ci.org/lnked/react-starter)

[![Code Climate](https://codeclimate.com/github/lnked/react-starter/badges/gpa.svg)](https://codeclimate.com/github/lnked/react-starter)

[![Issue Count](https://codeclimate.com/github/lnked/react-starter/badges/issue_count.svg)](https://codeclimate.com/github/lnked/react-starter)

---

React-starter a react web starter kit.

## Installation

#### GIT

```bash

git clone -b master [email protected]:lnked/react-starter.git

```

OR

```bash

git init

git remote add origin [email protected]:lnked/react-starter.git

git fetch origin

git pull origin master

```

Then run command

```bash

yarn

```

OR

```bash

npm i

```

## Run tasks

Start dev-server

```bash

yarn start

```

Build without compress

```bash

yarn build

```

Build with compress

```bash

yarn release

```

Analyze code

```bash

yarn analyze

```

Stats

```bash

yarn stats

```

Lint scripts

```bash

yarn lint:scripts

```

Lint styles

```bash

yarn lint:styles

```

Lint styles and scripts

```bash

yarn lint

```

Fix

```bash

yarn run lint:fix

```

## Build with environment

```bash

yarn release --env example

```

Requires a file `.env.example` file in the root folder of the project

You can add any files to your environments

# Code generation commands

### Add layout

```bash

yarn add-layout --name test-layout

yarn add-layout --name 'test layout'

```

#### Optional

```bash

yarn add-layout --name test-layout --type class (default)

yarn add-layout --name test-layout --type function

```

### Add page

```bash

yarn add-page --name test-page

yarn add-page --name 'test page'

```

#### Optional

```bash

yarn add-page --name test-page --type class (default)

yarn add-page --name test-page --type function

```

### Add fragment

```bash

yarn add-fragment --name test-fragment

yarn add-fragment --name 'test fragment'

```

#### Optional

```bash

yarn add-fragment --name test-fragment --type class (default)

yarn add-fragment --name test-fragment --type function

```

### Add component

```bash

yarn add-component --name test-component

yarn add-component --name 'test component'

```

#### Optional

```bash

yarn add-component --name test-component --type class (default)

yarn add-component --name test-component' --type function

```

## Features

- [x] Webpack 4

- [x] TypeScript

- [x] Styled Components

- [x] PostCss / scss

- [x] Svg sprites

- [x] MobX

- [x] Tests

- [x] Code generation

## Get in touch

- Bugs / Suggestions: [open an issue](https://github.com/lnked/react-starter/issues)