https://github.com/xuyizhe/brunch-with-riot

A Riot skeleton with Typescript
https://github.com/xuyizhe/brunch-with-riot

boilerplate brunch-skeleton pug riot sass skeleton typescript

Last synced: 2 months ago
JSON representation

A Riot skeleton with Typescript

• Host: GitHub
• URL: https://github.com/xuyizhe/brunch-with-riot
• Owner: xuyizhe
• License: mit
• Created: 2017-12-06T03:40:05.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-01-05T07:39:04.000Z (almost 8 years ago)
• Last Synced: 2025-06-22T11:35:57.074Z (4 months ago)
• Topics: boilerplate, brunch-skeleton, pug, riot, sass, skeleton, typescript
• Language: JavaScript
• Homepage: https://xuyizhe.github.io/brunch-with-riot/
• Size: 51.8 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# brunch-with-riot

A Riot skeleton with TypeScript.

[![Build Status](https://travis-ci.org/xuyizhe/brunch-with-riot.svg?branch=master)][travis]

[travis]: https://travis-ci.org/xuyizhe/brunch-with-riot

[![dependencies Status](https://david-dm.org/xuyizhe/brunch-with-riot/status.svg)](https://david-dm.org/xuyizhe/brunch-with-riot)

[![devDependency Status](https://david-dm.org/xuyizhe/brunch-with-riot/dev-status.svg)](https://david-dm.org/xuyizhe/brunch-with-riot#info=devDependencies)

## Installation

Clone this repo manually or use `brunch new DIR -s xuyizhe/brunch-with-riot`

## Getting started

* Install (if you don't have them):

    * [Node.js](http://nodejs.org): `brew install node` on OS X

    * [Brunch](http://brunch.io): `npm install -g brunch`

    * Brunch plugins and app dependencies: `npm install`

* Run:

    * `npm start` — watches the project with continuous rebuild. This will also launch HTTP server with [pushState](https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Manipulating_the_browser_history).

    * `npm run build` — builds minified project for production

* Learn:

    * `public/` dir is fully auto-generated and served by HTTP server.  Write your code in `app/` dir.

    * Place static files you want to be copied from `app/assets/` to `public/`.

    * [Brunch site](http://brunch.io), [Getting started guide](https://github.com/brunch/brunch-guide#readme)