Skip to content

A Sample Application for the Rokkit.ts Framework based on TypeScript and Node.js

License

Notifications You must be signed in to change notification settings

rokkit-ts/sample-application

Repository files navigation

Rokkit.ts a microservice framework build in TypeScript for Node.js. It focuses on a modular component system, developer exerience and good designed APIs to build any application without making restrictions.
Rokkit.ts tries to be adaptable for all needs. If you want to know more about the framework check out our Website.
The Framework is still in an early phase but allready provides functionality to build basic applications.

This project provides examples to show how rokkit.ts could be used.

Usage

First you need to install the project dependencies

npm i

You can run the project in the development mode or in production mode.

npm run-script dev // starts the development mode
npm start // runs the application in production mode

In order to run the application in production mode you need to build it.

npm run-script build

Once running the application you can test the API with the provided postman collection. You can either import it to postman directly or run it from the commandline. To run it from the commandline enter the following command.

npm test

Contribution

If you want to contribute to the project, please don't hesitate to send feedback, create issues or pull requests for open ones.

License

Rokkit.ts Core is Open Source software released under the MIT license.

Releases

No releases published

Packages

No packages published