https://github.com/motorcycle/motorcycle.ts

Your Type-Safe, Declarative and Reactive Toolkit for Modern Composable and Event-Driven Development
https://github.com/motorcycle/motorcycle.ts

declarative frp functional functional-programming mostjs mostly-dom motorcycle reactive typescript virtual-dom

Last synced: about 19 hours ago
JSON representation

Your Type-Safe, Declarative and Reactive Toolkit for Modern Composable and Event-Driven Development

• Host: GitHub
• URL: https://github.com/motorcycle/motorcycle.ts
• Owner: motorcycle
• License: mit
• Created: 2017-05-31T16:23:01.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-12T09:52:40.000Z (about 2 years ago)
• Last Synced: 2024-04-13T23:54:34.178Z (10 months ago)
• Topics: declarative, frp, functional, functional-programming, mostjs, mostly-dom, motorcycle, reactive, typescript, virtual-dom
• Language: TypeScript
• Homepage:
• Size: 1.56 MB
• Stars: 69
• Watchers: 4
• Forks: 3
• Open Issues: 102
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Motorcycle.ts




  





  A statically-typed, functional and reactive framework for modern browsers





[![ComVer](https://img.shields.io/badge/ComVer-compliant-brightgreen.svg)](https://github.com/staltz/comver)

[![Join the chat at https://gitter.im/motorcyclets/motorcycle](https://badges.gitter.im/motorcyclets/motorcycle.svg)](https://gitter.im/motorcyclets/motorcycle?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Build Status](https://travis-ci.org/motorcyclets/motorcycle.svg?branch=master)](https://travis-ci.org/motorcyclets/motorcycle)



## Packages

- [@motorcycle/types](./packages/types) -- A shared-kernel of types for Motorcycle

- [@motorcycle/stream](./packages/stream) -- Functional and reactive event streams for Motorcycle.ts

- [@motorcycle/run](./packages/run) -- A statically-typed, functional and reactive framework for modern browsers

- [@motorcycle/test](./packages/test) -- Testing functions for Motorcycle.ts

- [@motorcycle/dom](./packages/dom) -- Declarative, functional, reactive abstractions for the DOM

- [@motorcycle/mostly-dom](./packages/mostly-dom) -- Motorcycle.ts adapter for [mostly-dom](https://github.com/TylorS167/mostly-dom)

## Examples

- [Counter](./examples/counter)

- [Traffic Light](./examples/traffic-light)

- [Sokoban](./examples/sokoban) -- A type of transport puzzle, in which the player pushes boxes or crates around in a warehouse, trying to get them to storage locations.

- [Drag-n-Drop](./examples/drag-n-drop) -- A simple drag-n-drop reorderable list.

## Developing

### Requirements

* Latest stable version of [Node](https://github.com/creationix/nvm)

* Latest stable version of [Yarn](https://yarnpkg.com)

### For generating changelog (for those with NPM publishing rights)

* [Ruby >= v2.1.0](https://www.ruby-lang.org/en/downloads/)

* [Github Personal Access Token](https://github.com/settings/tokens)

  - Save the access token you generated for later usage

In your terminal, run the following:

**Note:** `sudo` may be required for all of the following terminal commands.

```sh

# If you're on a Debian-based Linux Distribution, install rake

gem install rake

# Install Github Changelog Generator

gem install github_changelog_generator

```

In your `.bash_profile`, `.zshrc` or equivalent shell configuration file, add the 

following:

```sh

export CHANGELOG_GITHUB_TOKEN=$GITHUB_PERSONAL_ACCESS_TOKEN_GENERATED_ABOVE

```

In a new terminal, you should now be able to successfully run `yarn changelog`

to generate an up-to-date `CHANGELOG.md`.