Skip to content
This repository has been archived by the owner on Apr 6, 2023. It is now read-only.

Upgrade to CRA 1.0.10 #49

Merged
merged 3 commits into from
Aug 24, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 32 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,54 @@

Kickstarts a new React app

### The Webpack configuration sits in [our Create React App fork](https://github.com/Neverbland/create-react-app/tree/master/packages/react-scripts) for easier maintainability.
This repository is intended to replace the `/template` folder of Create React App.

This package includes scripts and configuration used by [Create React App](https://github.com/facebookincubator/create-react-app).<br>
Please refer to its documentation:

* [User Guide](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.


## Features

* React
* [Every Create React App features](https://github.com/facebookincubator/create-react-app#whats-inside)
* React Router
* Webpack
* SCSS
* hot reloading (css and React components)
* SVG sprites
* Assets optimisation (png, jpg, svg, ...)
* Automatic polyfilling (using Polyfill.io)

## Getting started

- Install: `npm install`
- Start dev: `npm start`
- Production build: `npm run build`
### `npm install` or `yarn start`
Install the project.

## Testing
### `npm start` or `yarn start`

- Lint SCSS: `npm run lint:scss`
Runs the app in development mode.<br>
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

### `npm run build` or `yarn build`

Builds the app for production to the `build` folder.<br>
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.<br>
By default, it also [includes a service worker](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#making-a-progressive-web-app) so that your app loads from local cache on future visits.

## Writing JS

We use [EditorConfig](http://editorconfig.org/) for code consistency. Please see below to add support to your editor.

## Writing CSS

We use [BEM](https://en.bem.info/) across our projects.

## Testing

- Lint SCSS: `npm run lint:scss`

## Polyfills

We use [Polyfill.io](https://polyfill.io/v2/docs/) to polyfill missing Javascript functionality. Simply add any missing functionality by appending the polyfill.io url in `src/public/index.html` with the feature you need.
Expand All @@ -35,10 +58,9 @@ We use [Polyfill.io](https://polyfill.io/v2/docs/) to polyfill missing Javascrip

- ESLint ([Atom Plugin](https://atom.io/packages/linter-eslint)/[Sublime Plugin](https://github.com/roadhump/SublimeLinter-eslint))
- SASS Lint ([Atom Plugin](https://atom.io/packages/linter-sass-lint)/[Sublime Plugin](https://github.com/skovhus/SublimeLinter-contrib-sass-lint))
- EditorConfig ([Atom Plugin](https://atom.io/packages/editorconfig)/[Sublime Plugin](https://github.com/sindresorhus/editorconfig-sublime))
- Beautifier ([Atom Plugin](https://atom.io/packages/atom-beautify))

## License

[MIT license](http://opensource.org/licenses/MIT)

This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app).
40 changes: 0 additions & 40 deletions config/babel.dev.js

This file was deleted.

38 changes: 0 additions & 38 deletions config/babel.prod.js

This file was deleted.

27 changes: 0 additions & 27 deletions config/env.js

This file was deleted.

56 changes: 0 additions & 56 deletions config/eslint.js

This file was deleted.

1 change: 0 additions & 1 deletion config/jest/CSSStub.js

This file was deleted.

1 change: 0 additions & 1 deletion config/jest/FileStub.js

This file was deleted.

4 changes: 0 additions & 4 deletions config/jest/transform.js

This file was deleted.

40 changes: 0 additions & 40 deletions config/paths.js

This file was deleted.

98 changes: 0 additions & 98 deletions config/sasslint.yml

This file was deleted.

Loading