Giter VIP home page Giter VIP logo

node-template-generator's Introduction

Documentation Examples Discord Twitter

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

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:

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.

node-template-generator's People

Contributors

stephanewen avatar tillrohrmann avatar slinkydeveloper avatar gvdongen avatar jackkleeman avatar ahmedsoliman avatar

Stargazers

George Kontridze avatar  avatar  avatar Eshcar Hillel avatar Guillaume Vauvert avatar Alex Kwiatkowski avatar

Watchers

Michael Latta (TechnoMage) avatar Lari Hotari avatar Tristan Zajonc avatar Teemu avatar  avatar Ed Bishop avatar Jowanza Joseph avatar Karim avatar Jaebin Yoon avatar Guy Fighel avatar Guillaume Vauvert avatar David Morin avatar Harry Laoulakos avatar Robin Stephenson avatar Amidamaru avatar  avatar Bede Jordan avatar Ankit Chaudhary avatar MRomeh avatar Gonzalo avatar east avatar Jagadesh Adireddi avatar Lars De Maere avatar Aleksandar Skrbic avatar Qingsheng Ren avatar  avatar

Forkers

tillrohrmann

node-template-generator's Issues

The template is not generating any readme

Usually project generators generate together with the project skeleton a README.md with the next steps after the code generation. We should probably do that as well, perhaps we could start simple by simply writing the README of this repo.

Error: Cannot find module './generated/proto/example' or its corresponding type declarations.

npx -y @restatedev/create-app && cd restate-node-template
npm install && npm run build

Gives:

added 75 packages, and audited 76 packages in 9s

8 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

> [email protected] build
> tsc --noEmitOnError

src/app.ts:8:8 - error TS2307: Cannot find module './generated/proto/example' or its corresponding type declarations.

8 } from "./generated/proto/example";
         ~~~~~~~~~~~~~~~~~~~~~~~~~~~


Found 1 error in src/app.ts:8

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.