about summary refs log tree commit diff
path: root/boilerplate/typescript/README.md
diff options
context:
space:
mode:
authorWilliam Carroll <wpcarro@gmail.com>2020-03-23T22·12+0000
committerWilliam Carroll <wpcarro@gmail.com>2020-03-23T22·43+0000
commit9fdf4d00fa4abcdb356a919d293fd8686407ccf9 (patch)
tree3227c211118bcfe60f46c6f442fbc5035b2166d9 /boilerplate/typescript/README.md
parent1cc1ce5ccf88adcbd064ac46a070b94faa04b871 (diff)
Support boilerplate for TypeScript projects
I would like to support boilerplate code for ReasonML, TypeScript,
ClojureScript, and Elm projects before I specialize in any of these
frameworks. All of my projects should use TailwindCSS.

All of this boilerplate should offer:
- Same command to start developing
- Same API to build and deploy
- TailwindCSS support
- Basic boilerplate for components, state, and routes

This TypeScript boilerplate is not complete, but I would like to commit the
progress in case I do not return to this for awhile.
Diffstat (limited to 'boilerplate/typescript/README.md')
-rw-r--r--boilerplate/typescript/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/boilerplate/typescript/README.md b/boilerplate/typescript/README.md
new file mode 100644
index 000000000000..a54186a9f29e
--- /dev/null
+++ b/boilerplate/typescript/README.md
@@ -0,0 +1,26 @@
+# Frontend Boilerplate
+
+While many times I prefer using alt-languages like ReasonML, ClojureScript, or
+Elm, sometimes I prefer to write an application using TypeScript. This directory
+contains the necessary starter code to create these applications.
+
+- React: Maps application state to UI
+- React-Router: Stateful routing for SPAs
+- Redux: Application state management
+- TypeScript: Type-safety
+- TailwindCSS: Styling library using utility classes
+- Prettier: Source code formatting
+- Jest: Test runner
+
+## Developing
+
+```shell
+$ nix-shell
+$ yarn run dev
+```
+
+## Building
+
+```shell
+$ nix-build
+```