README.md

Restate Template for TypeScript / NodeJS services

This is a template for a Restate-based service in TypeScript.

tl;dr

To create a template service, use this sequence of commands:

npx -y @restatedev/create-app@latest
cd restate-node-template

npm install

npm run app-dev

For more details, check the Get started documentation

Useful links

• Restate Typescript SDK: https://github.com/restatedev/sdk-typescript
• The Restate documentation: https://docs.restate.dev/
• Restate Docker container: https://hub.docker.com/r/restatedev/restate

Contributing to this template

The template that is generated by the npx @restatedev/create-app is available here: https://github.com/restatedev/examples/tree/main/templates/typescript

The last released version is automatically picked up by the tool.

Releasing via release-it

Releasing a new npm package from this repo requires:

• SSH access configured for Github in order to push commits and tags to GitHub
• A GitHub personal access token with access to https://github.com/restatedev/node-template-generator in your environment as GITHUB_TOKEN in order to create a Github release

npm run release
# now select what type of release you want to do and say yes to the rest of the options

The actual npm publish is run by GitHub actions once a GitHub release is created.

Releasing manually

1. Create and push a tag of the form vX.Y.Z to the upstream repository
2. Create a new GitHub release

Creating the GitHub release will trigger npm publish via GitHub actions.