geoff
/
riot-starter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

tweak

This commit is contained in:
Geoff Doty 2018-12-02 02:26:38 -05:00
parent 7a0fe7500e
commit 064ff70453
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,11 +1,11 @@
# RiotJS App Starter # RiotJS App Starter
> A Rapid Application Starter kit for RiotJS minimalists > A Rapid Application Starter kit for RiotJS minimalists
Rapidly prototype your next single-page application, with a `zero-build` out-of-the-box web-component solution using [RiotJS](https://riot.js.org/) for the fastest way to iterate over UI for development -- **bar-none**. Rapidly prototype your next single-page application, with a `zero-build` out-of-the-box web-component solution using [RiotJS](https://riot.js.org/) for the fastest way to iterate over UI for development -- **bar-none**.
No crazy syntax, just HTML, CSS and JavaScript. No crazy syntax, just HTML, CSS and JavaScript.
No isolated eco-system, work with any library, any tool, any way you want! No isolated eco-system, work with any library, any tool, any way you want!
[RiotJS](https://riot.js.org/) is tiny; tiny foot print, tiny API, and this leads it to be extremely fast to learn -- closest to web standards as you can get. [RiotJS](https://riot.js.org/) is tiny; tiny foot print, tiny API, and this leads it to be extremely fast to learn -- closest to web standards as you can get.
@ -24,7 +24,7 @@ What are you waiting for -- **GO FORTH AND BUILD YOUR APP, RAPIDLY!**
**Requirements** **Requirements**
- [NodeJS](https://nodejs.org/) - [NodeJS](https://nodejs.org/)
> Installs `vendor/` dependencies and `npm build` to get your project into production > Installs `vendor/` dependencies and `npm build` to get your project into production
@ -88,14 +88,14 @@ These files are usually saved as `my-component.tag`, but to get proper syntax hi
Of course we want our component to do more, so... Of course we want our component to do more, so...
...*for now*, go check out the [RiotJS GuideI](https://riot.js.org/guide/) ...*for now*, go check out the [RiotJS Guide](https://riot.js.org/guide/)
## Build for Production ## Build for Production
When you are ready to move to production you can run `npm build`. This will create a `dist` folder with all your optimized assets, web-components, vendor dependencies and remove the riot `runtime-compiler` to shave off another 100kb When you are ready to move to production you can run `npm build`. This will create a `dist` folder with all your optimized assets, web-components, vendor dependencies and remove the riot `runtime-compiler` to shave off another 100kb
Check out the [gulpfile]('gulpfile.js') for all the build options if you do not want to build everything. Every task is commented, and split-up so you can grep it easily. Check out the [gulpfile]('./gulpfile.js') for all the build options if you do not want to build everything. Every task is commented, and split-up so you can grep it easily.
## Testing ## Testing
@ -111,7 +111,7 @@ Check out the [gulpfile]('gulpfile.js') for all the build options if you do not
## TODO ## TODO
- Include a testing framework [Jasmine](https://jasmine.github.io/), [test.it](https://github.com/n2geoff/testit), or? - Include a testing framework [Jasmine](https://jasmine.github.io/), [test.it](https://github.com/n2geoff/testit), or?
- Is good AJAX support the missing ingredient? or is`fetch` good enough? - Is good AJAX support the missing ingredient? or is`fetch` good enough?
- add routing example - add routing example
## Support ## Support