leosuncin / deepkit-todo-app-example

Example app with DeepKit framework

App

Welcome to your new Deepkit app.

Start server

$ npm run app server:start

2022-08-07T21:25:32.567Z [LOG] Start server ...
2022-08-07T21:25:32.569Z [LOG] RPC Controller HelloWorldControllerRpc /main
2022-08-07T21:25:32.569Z [LOG] 1 HTTP routes
2022-08-07T21:25:32.569Z [LOG] HTTP Controller HelloWorldControllerHttp
2022-08-07T21:25:32.569Z [LOG]   GET /hello/:name
2022-08-07T21:25:32.569Z [LOG] HTTP listening at http://0.0.0.0:8080
2022-08-07T21:25:32.569Z [LOG] Server started.

You can now open http://localhost:8080/hello/Peter.

Or open the Framework Debugger: http://localhost:8080/\_debug/ (if debug is enabled in new FrameworkModule({ debug: true }))

CLI

The file app.ts is at the same your CLI entrypoint to your application. There you can start the HTTP server or execute custom CLI commands.

One built-in CLI command is server:start which starts the HTTP/RPC server:

$ npm run app server:start

# or if supported
$ ./app.ts server:start

Another is an example hello from ./src/controller/hello-world.cli.ts, which you can start as follows:

npm run app hello World!

# or if supported
$ ./app.ts hello World!

Run just npm run app to see all available commands.

If your operating system supports it, you can also call app.ts directly:

$ ./app.ts server:start

HTTP

An example HTTP controller is at ./src/controller/hello-world.http.ts which can be accessed by any HTTP client, after starting the server with npm run app server:start:

$ curl -v http://localhost:8080/hello/world

RPC

An example RPC controller is at ./src/controller/hello-world.rpc.ts which can be accessed by a Deepkit RPC client, after starting the server with npm run app server:start:

$ npm run client-rpc

# or if supported
$ ./client.rpc.ts

Watcher

If you want to work on some server APIs and the server should restart automatically for each change, use app:watch:

$ npm run app:watch server:start

Deploy

To deploy the app, you should build it via npm run build. It will compile TS to JS and puts it in dist/ folder.

$ npm run build
$ node dist/app.js hello world

# or start server.
$ APP_ENVIRONMENT=production node dist/app.js server:start

Make sure to set the environment APP_ENVIRONMENT=production variable correctly, or add a production.env file with APP_ENVIRONMENT=production. In app.ts it's configured to use a JSON logger and disabled framework debugger as soon as production environment is set.

Change port

To change the port or host, use APP_FRAMEWORK_PORT and APP_FRAMEWORK_HOST respectively.

$ APP_FRAMEWORK_PORT=9090 APP_FRAMEWORK_HOST=127.0.0.1 node dist/app.js server:start
2022-08-07T21:38:45.744Z [LOG] HTTP listening at http://127.0.0.1:9090