Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
59 commits
Select commit Hold shift + click to select a range
f91d6c6
Add editorconfig
artfuldev Oct 18, 2017
0c5949f
Stop ignoring typings
artfuldev Oct 18, 2017
26946c4
Remove launch configuration
artfuldev Oct 18, 2017
ce3e10b
Move index.html into src
artfuldev Oct 18, 2017
cd40da8
Update license
artfuldev Oct 18, 2017
8b0bb31
Remove styles
artfuldev Oct 18, 2017
534d630
Remove typings
artfuldev Oct 18, 2017
de6d9c5
Add a favicon
artfuldev Oct 18, 2017
aa63fc8
Update packages
artfuldev Oct 18, 2017
360cb27
Add a lockfile
artfuldev Oct 18, 2017
0f8999b
Update webpack configuration
artfuldev Oct 18, 2017
40bdacb
Add @cycle/http and switch-path to vendor
artfuldev Oct 18, 2017
065b0af
Update tsconfig.json
artfuldev Oct 18, 2017
1e184ef
Update README
artfuldev Oct 18, 2017
1238ea5
Simplify VS Code part of README
artfuldev Oct 18, 2017
61db540
Copy images and fonts upon compilation
artfuldev Oct 18, 2017
6ec61bc
Add missing packages
artfuldev Oct 18, 2017
55f8886
Update lockfile
artfuldev Oct 18, 2017
ff05704
Move devDependencies to bottom
artfuldev Oct 18, 2017
381ed7e
Fix dist path
artfuldev Oct 18, 2017
90eda17
Add a basic app
artfuldev Oct 18, 2017
f0f2f43
Add history
artfuldev Oct 18, 2017
c5963f1
Allow relative resolution of project sources
artfuldev Oct 18, 2017
8136c8f
Simplify layouts
artfuldev Oct 18, 2017
5fa1a2d
Add header
artfuldev Oct 18, 2017
6c238cc
Add pluck
artfuldev Oct 18, 2017
4cc697c
Add a home route
artfuldev Oct 18, 2017
9d1d351
Fix routing
artfuldev Oct 18, 2017
b9b0231
Make layouts optional
artfuldev Oct 18, 2017
0093c8a
Fix chunkfile names
artfuldev Oct 18, 2017
85bf32c
Simplify layout resolution logic
artfuldev Oct 18, 2017
318f966
Add css utilities for typestyle
artfuldev Oct 18, 2017
b1ed27c
Add a splash of style
artfuldev Oct 18, 2017
4e85cf3
Fix bottom margin for header
artfuldev Oct 18, 2017
b83e0e5
Add about route
artfuldev Oct 18, 2017
11cab42
Add a NavMenu component
artfuldev Oct 18, 2017
32b512f
Move Header into folder
artfuldev Oct 18, 2017
be579d4
Add a nav menu to header
artfuldev Oct 18, 2017
12e249f
Simplify styles for clarity
artfuldev Oct 18, 2017
74af61d
Add an example of loading route definitions from sub-route
artfuldev Oct 18, 2017
ddd2c57
Add a NavLink with click capturing
artfuldev Oct 18, 2017
32edece
Style the nav menu a bit
artfuldev Oct 18, 2017
c009724
Remove debugging handler
artfuldev Oct 18, 2017
6713809
Add a github driver
artfuldev Oct 18, 2017
b00f628
Allow components and layouts to return partial sinks
artfuldev Oct 18, 2017
5f27abb
Add github driver to app
artfuldev Oct 18, 2017
65c22b5
Load commits list
artfuldev Oct 18, 2017
fadde58
Add a list item component for commits
artfuldev Oct 19, 2017
0640510
Filter out merge commits
artfuldev Oct 19, 2017
68127ec
Fix type signature
artfuldev Oct 19, 2017
8d38bc0
Capture navigation intent first
artfuldev Oct 19, 2017
5a9f2ec
Add a back button
artfuldev Oct 19, 2017
456d4ba
Add a back button to details page
artfuldev Oct 19, 2017
aaff242
Complete details
artfuldev Oct 19, 2017
57c095b
Add styling and details to commit list items
artfuldev Oct 19, 2017
67bc33c
Update README
artfuldev Oct 19, 2017
ac79d24
Add more planned features
artfuldev Oct 19, 2017
82d3727
Add launch configuration for Google Chrome
artfuldev Oct 19, 2017
7f2d57a
Update README
artfuldev Oct 19, 2017
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
root = true

[*]
end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 2
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,3 @@ jspm_packages

# Generated files
dist

# Typings
typings/
20 changes: 5 additions & 15 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -1,24 +1,14 @@
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Launch Chrome against localhost, with sourcemaps",
"type": "chrome",
"request": "launch",
"url": "http://localhost:3000",
"sourceMaps": true,
"webRoot": "${workspaceRoot}",

//This line is important, since it instructs chrome to run in a separate, sandbox instance.
//This way, other running chrome instances won't prevent remote debugging from running.
"userDataDir": "C:\\temp\\chrome-dev-instance"
},
{
"name": "Attach to Chrome, with sourcemaps",
"type": "chrome",
"request": "attach",
"port": 9222,
"sourceMaps": true,
"name": "Launch Chrome against localhost",
"url": "http://localhost:3030",
"webRoot": "${workspaceRoot}"
}
]
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2016 Cycle.js Community
Copyright (c) 2017 Sudarsan Balaji and Cycle.js Community

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
48 changes: 32 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,38 @@
# typescript-starter-cycle
A simple project for getting started with TypeScript in cycle.js, using Webpack.
An opinionated starter for Cycle.js projects powered by TypeScript.

## Patterns
* Simple Starter - this branch
* [Model-View-Intent (MVI) Starter](https://github.com/cyclejs-community/typescript-starter-cycle/tree/add-model-view-intent-pattern)
* [MVI with Reducers Starter](https://github.com/cyclejs-community/typescript-starter-cycle/tree/add-reducer-pattern)
* [MVI with Property Streams Starter](https://github.com/cyclejs-community/typescript-starter-cycle/tree/add-property-stream-pattern)
## Opinions
* TypeScript rocks. We use TypeScript as much as possible.
* Visual Studio Code rocks. We use Visual Studio Code as the recommended editor.
* Webpack rocks. We use webpack only.

<br>
<br>
<br>
<br>
<hr>
## Features
* TypeScript
* Webpack
* TypeStyle for styles
* Simple routing with layouts
* Hot Module Reloading
* Async imports and dynamic routing
* Visual Studio Code integrations

##### Visual Studio Code Specifics
This repository has workspace settings and launch configuration for [Visual Studio Code](https://code.visualstudio.com/) as candy. The launch configuration will only work when the [Debugger for Chrome extension](https://code.visualstudio.com/blogs/2016/02/23/introducing-chrome-debugger-for-vs-code) is installed. The [npm Script Runner extension](https://marketplace.visualstudio.com/items?itemName=eg2.vscode-npm-script) for Visual Studio Code is also recommended.
### Planned
* Unit testing with Mocha and Chai
* UI Integration tests with Cypress
* Explanation of folder structure
* Wiki section on recommended/best practices
* Better README (duh!)

For a quickstart guide/tutorial, see [here](https://journal.artfuldev.com/cycle-js-quick-start-with-typescript-and-webpack-in-visual-studio-code-e562a009e9d6#.qpn2b7vkl)
## Notes

##### Notes
> If hosting on github-pages, you need to remove `dist` entry in the `.gitignore` file.
### Visual Studio Code Specifics
This repository is optimized for [Visual Studio Code](https://code.visualstudio.com/).
We have launch configurations, an editor config file, and workspace settings.

To make full use of these, you need the following extensions:
* [Debugger for Chrome](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome)
* [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)

### Troubleshooting / Tips
* 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`.
* 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>' : '/';`
* If you need help with something, or have feedback, suggestions, feel free to open an issue on this repository.
Loading