aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 3d43f90e50deb3bc51a4b62452b11e253693036e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# Yet another riot.js + webpack project skeleton

Built with `riot.js`, `webpack`, `SASS` and ES6 syntax.

## Installation with yarn

Run `yarn install` to install all dependencies.

## Running the demo

*  Run the mock backend with `yarn mock-api`
*  Run `yarn start` in another terminal to start the front-end dev server
*  Check out http://localhost:8888!

## Running in production

*  Run `yarn build` to build an optimized web-ready bundle
*  Use [Caddy](https://caddyserver.com/) or your favourite static server to server the `public` directory. A template for the `Caddyfile` already exists in the root directory

## Configuration

*  `dotenv` has been set up to read environment variables from the `.env` file.
*  The site template file can be found in `src/index.ejs`. HtmlWebpackPlugin injects the javascript bundle when building.
*  Create new components with [create-riot-component](https://www.npmjs.com/package/create-riot-component)