Skip to content

Latest commit

 

History

History
80 lines (54 loc) · 2.29 KB

README.md

File metadata and controls

80 lines (54 loc) · 2.29 KB

⏏ riot-um

Simple Riot App generated based on riot-cli

Built to provide an interface to manage Users and Groups in an easy and fast way

RiotJS startkit, based on create-react-app and react-scripts.

Package included simple app example, webpack dev server with riot hot reload and less, sass, stylus support. ES6 features available too. Jest with riot support for testing. ES6 and eslint in riot tag.

Just read https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md but replace all "react" word to "riot" :)

In Action

https://gyazo.com/0bb4629e545f72956a95a3b80fcba7e3

⚡ Start dev-server

git clone https://github.com/saurshaz/riot-um
cd riot-um
npm install
npm start

go to http://localhost:9999

✔ Testing

npm test
npm test -- --coverage

read more about testing

Add flow type checker.

npm install flow-bin
npm run flow

Write in head your js files //@flow weak to enable flow checker

⚗ Build for production

npm run build

Check build result

npm run check_build

☁ Deploy

For example deploy app to firebase

npm install -g firebase-tools
firebase login
firebase init
npm run deploy

⚙ Configuration options

Modify the .env file in the root of the generated project, and add any of the configuration options below 👇 to enable that feature.

The generated project comes with LESS support by default, but you can add SASS or Stylus at any time by edit the options from the .env file.

Others

  • HTTPS=true - enable https in localhost
  • PORT=9999 - change port
  • OPEN_BROWSER=false - don't open browser after running webpack server

Read more about .env files