|
1 | 1 | # typescript-starter-cycle
|
2 | 2 | An opinionated starter for Cycle.js projects powered by TypeScript.
|
3 | 3 |
|
| 4 | +## Opinions |
| 5 | +* TypeScript rocks. We use TypeScript as much as possible. |
| 6 | +* Visual Studio Code rocks. We use Visual Studio Code as the recommended editor. |
| 7 | +* Webpack rocks. We use webpack only. |
| 8 | + |
4 | 9 | ## Features
|
5 | 10 | * TypeScript
|
6 | 11 | * Webpack
|
7 |
| -* Visual Studio Code integrations |
8 |
| -* Hot Module Reloading |
9 | 12 | * TypeStyle for styles
|
| 13 | +* Simple routing with layouts |
| 14 | +* Hot Module Reloading |
| 15 | +* Async imports and dynamic routing |
| 16 | +* Visual Studio Code integrations |
| 17 | + |
| 18 | +### Planned |
10 | 19 | * Unit testing with Mocha and Chai
|
11 | 20 | * UI Integration tests with Cypress
|
12 |
| -* Async imports and dynamic routing |
13 |
| -* Simple routing with layouts |
| 21 | +* Better README (duh!) |
| 22 | + |
| 23 | +## Notes |
14 | 24 |
|
15 |
| -##### Visual Studio Code Specifics |
| 25 | +### Visual Studio Code Specifics |
16 | 26 | This repository is optimized for [Visual Studio Code](https://code.visualstudio.com/).
|
17 | 27 | We have launch configurations, an editor config file, and workspace settings.
|
18 | 28 |
|
19 | 29 | To make full use of these, you need the following extensions:
|
20 | 30 | * [Debugger for Chrome](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome)
|
21 | 31 | * [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
|
22 | 32 |
|
23 |
| -##### Notes |
| 33 | +### Troubleshooting / Tips |
24 | 34 | * If using on Windows machines, make sure you have the [build tools](https://github.com/felixrieseberg/windows-build-tools) ready before doing an `npm install`.
|
25 | 35 | * If hosting on a subdirectory, you need to change the `PROJECT_PUBLIC_PATH` in `webpack.config.js` only for production. You can do this by changing line #32 of the file to `var PROJECT_PUBLIC_PATH = __PROD__ ? '<your-public-path-here>' : '/';`
|
0 commit comments