actor-boilerplate - GitLite

KO | EN

gitlite — search

#javascript #python #react #go #android #deep-learning #docker #macos #nodejs #cli #vue #pytorch #security #mcp

actor-boilerplate

(★ 430)

A starting point for web apps based on the actor model.

File Explorer

Download Latest Version (.zip)

- - state.ts
  - ui.ts
- bootstrap.ts
- worker.ts
- index.html
.gitignore
LICENSE
package-lock.json
package.json
README.md
rollup.config.js
tsconfig.json
tslint.json

# Installation Guide

1. Get the code

git clone https://github.com/PolymerLabs/actor-boilerplate

Downloads the entire project code from GitHub to your computer.

cd actor-boilerplate

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

$ npm install

Downloads and installs the libraries listed in package.json.

$ npm run build

Builds optimized production files.

$ npm run serve

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Actor Boilerplate

A starting point for web apps based on the actor model.

<p align="center">
  <img src="https://user-images.githubusercontent.com/617438/48304411-026e9e80-e4ce-11e8-86b9-250c9566e2bb.png" alt="Screenshot of a stopwatch web app that uses the Actor model">
</p>

## Chrome Dev Summit 2018 Talk
[Architecting Web Apps - Lights, Camera, Action!](https://www.youtube.com/watch?v=Vg60lf92EkM&list=PLNYkxOF6rcIDjlCx1PcphPpmf43aKOAdF&index=17&t=0s)

We also wrote a series of blog posts with more detail on web development with the actor model:

- [The 9am Rush Hour]
- [Lights, Camera, Action!]
- [Headless Web Development]

## What is this repository that am I looking at?

This is a very basic web app that uses the [actor model]. The actor model helps you to break your app’s core logic into small pieces that have to communicate with messages instead of using function calls. Adopting this model has multiple benefits on the web:

- Yields to browser (it naturally leads to chunked code)
- Encourages lazy-loading and code splitting
- Gives you a clear separation of concerns
- Makes moving code off-main-thread easier
- Resilience against unexpected long-running tasks
- Enables multi-modality for web apps

## What’s in here?

This boilerplate is a starting point to build web apps based on the actor model. It provides a build system that allows you to easily lazy-load actors and split your code. It relies on [actor-helpers] for the implementation of the actors and the messaging system. (Please read the docs of [`actor.ts`][actor.ts] for more details and examples.)

Both this build system and the actor-helpers library are provided by us for convenience. You are encouraged to explore your own approach to actorize your code.

## How do I use this?

To get started, you can either [download] a snapshot of the master branch or fork this repository. Then run:

```
$ npm install
$ npm run build
$ npm run serve
```

and navigate to the address shown on the console to see the app.

### Static content

All content in `static` will be copied to the root of the output folder. This is the place for stylesheets, images and other files that don’t need any processing at build time.

### Bootstrapping

The entire web app bootstraps itself by loading the `bootstrap.ts` entrypoint. This is where we initialize the messaging system and create workers.

### Actors

All actors are in the `src/actors` folder. For example, the state actor runs in a worker as we call `hookup("state", new StateActor())` in `worker.ts`. However, if an actor explicitly requires access to the DOM, you can use this call in `bootstrap.ts` as well.

The message system takes care of delivering messages, regardless of where the actor is run. We strongly encourage to default all actors in a worker and only run an actor on the main thread if necessary.

Note that while we have a single `worker.ts` in this project, larger projects can create as many workers as they like. Since messages are delivered irrespective of where an actor lives, you can assign any actor to any worker.

For example, if you have one actor that performs very expensive tasks, such as encoding and decoding messages, that actor can live in its own worker. Other (less CPU-intensive) actors can be grouped together in a single worker.

## More examples

- **Todo note-taking app:** Mandatory Todo app using the actor model with [preact] and [ImmerJS] ([branch][todo])

---

License BSD-3-clause

Please note: this is not a Google product.

[actor-helpers]: https://github.com/PolymerLabs/actor-helpers
[actor.ts]: https://github.com/PolymerLabs/actor-helpers/blob/master/src/actor/Actor.ts
[download]: https://github.com/PolymerLabs/actor-boilerplate/archive/master.zip
[actor model]: https://en.wikipedia.org/wiki/Actor_model
[the 9am rush hour]: https://dassur.ma/things/the-9am-rush-hour/
[lights, camera, action!]: https://dassur.ma/things/lights-camera-action/
[headless web development]: https://dassur.ma/things/headless-web-development/
[todo]: https://github.com/PolymerLabs/actor-boilerplate/tree/example/todo
[preact]: https://preactjs.com/
[immerjs]: https://github.com/mweststrate/immer