portfolio/README.md

63 lines
1.4 KiB
Markdown

# Portfolio
These are my personal projects. This is where I come to refactor to my heart's content.
# Projects
## [Gallery](./packages/gallery/README.md)
A browser-based app for viewing photos. (WIP)
# Major Tools
## [FRP tools](./packages/frptools/README.md)
Observable property and computed value stores designed to work together for storing real and derived
state.
## [Portal](./packages/portal/README.md)
A utility to expose an asynchronous API between a web worker and its parent.
## [PouchType](./packages/pouchtype/README.md)
An type-based abstraction layer over PouchDB inspired by [Hood.ie](https://hood.ie/) and
[Django](https://djangoproject.com)
## [Router](./packages/router/README.md)
A slim and unopinionated hash router.
# Minor Tools
## [Background Task](./packages/backgroundtask/README.md)
A simple way to run a task on the main thread without disrupting the UX (much).
## [Trimkit](./packages/trimkit/README.md)
Javascript API abstractions to enhance minification by substituting variables. It's really quite
silly.
# Dependencies
These are `npm --global` dependencies:
- [Lerna 2.0.0](https://lernajs.io/)
# Installation
1. Install global dependencies
2. `git clone` the repository
3. `lerna bootstrap`
# Run Tests
`lerna run test`
# Development
[Cloud9 IDE](https://github.com/c9/core) is available via Docker container for development.
`docker-compose up cloud9`