From f039169b1d9ceae38c3ca4d8a7f6e6a3bff06c45 Mon Sep 17 00:00:00 2001 From: Aarni Halinen Date: Mon, 3 Jun 2019 18:24:07 +0300 Subject: [PATCH] Fix md-warnings --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 61891dc..cca03f2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # Web 2.0 Frontend + Minimal starter kit with hot module replacement (HMR) for rapid development. * **[React](https://facebook.github.io/react/)** (16.x) @@ -12,13 +13,15 @@ Minimal starter kit with hot module replacement (HMR) for rapid development. * Image loading/minification using [Image Webpack Loader](https://github.com/tcoopman/image-webpack-loader) * Typescript compiling using [Awesome Typescript Loader](https://github.com/s-panferov/awesome-typescript-loader) (5.x) * Code quality (linting) for Typescript and SASS/CSS. - + ## Installation + 1. Clone/download repo 2. `npm install` ## Usage -**Development** + +### Development `npm start` @@ -29,9 +32,9 @@ Minimal starter kit with hot module replacement (HMR) for rapid development. `npm run plop` -* Create a new component interactively using plop templates +* Create a new component interactively using plop templates -**Production** +### Production `npm run start-prod` @@ -40,13 +43,13 @@ Minimal starter kit with hot module replacement (HMR) for rapid development. --- -**All commands** +### All commands Command | Description --- | --- `npm run start-dev` | Build app continously (HMR enabled) and serve @ `http://localhost:3000` `npm run start-prod` | Build app once (HMR disabled) and serve @ `http://localhost:3000` -`npm run build` | Build app to `/dist/` +`npm run build` | Build app to `/dist/` `npm run test` | Run e2e and unit tests `npm run test:unit` | Run unit tests with Jest `npm run test:e2e` | Run end-to-end tests with TestCafé @@ -56,6 +59,7 @@ Command | Description `npm run start` | (alias of `npm run start-dev`) ## See also + * [React Webpack Babel Starter](https://github.com/vikpe/react-webpack-babel-starter) * [Isomorphic Webapp Starter](https://github.com/vikpe/isomorphic-webapp-starter)