https://github.com/restatedev/node-template-generator

Template generator for Restate TypeScript/NodeJS SDK: `npx @restatedev/create-app`
https://github.com/restatedev/node-template-generator

Last synced: about 1 year ago
JSON representation

Template generator for Restate TypeScript/NodeJS SDK: `npx @restatedev/create-app`

• Host: GitHub
• URL: https://github.com/restatedev/node-template-generator
• Owner: restatedev
• License: mit
• Created: 2023-05-12T10:51:47.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2025-01-09T14:56:40.000Z (over 1 year ago)
• Last Synced: 2025-05-31T08:32:41.644Z (about 1 year ago)
• Language: JavaScript
• Homepage: https://restate.dev/
• Size: 554 KB
• Stars: 5
• Watchers: 25
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Documentation](https://img.shields.io/badge/doc-reference-blue)](https://docs.restate.dev)

[![Examples](https://img.shields.io/badge/view-examples-blue)](https://github.com/restatedev/examples)

[![Discord](https://img.shields.io/discord/1128210118216007792?logo=discord)](https://discord.gg/skW3AZ6uGd)

[![Twitter](https://img.shields.io/twitter/follow/restatedev.svg?style=social&label=Follow)](https://twitter.com/intent/follow?screen_name=restatedev)

# Restate Template for TypeScript / NodeJS services

This is a template for a [Restate-based](https://restate.dev/) service in [TypeScript](https://www.typescriptlang.org/).

## tl;dr

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

```shell

npx -y @restatedev/create-app@latest

cd restate-node-template

npm install

npm run app-dev

```

For more details, check the [Get started documentation](https://docs.restate.dev/get_started/quickstart?sdk=ts)

# 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/typescript/templates/node

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](https://docs.github.com/en/authentication/connecting-to-github-with-ssh) 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

```bash

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

1. [Create a new GitHub release](https://github.com/restatedev/node-template-generator/releases)

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