https://github.com/rokkit-ts/sample-application

A Sample Application for the Rokkit.ts Framework based on TypeScript and Node.js
https://github.com/rokkit-ts/sample-application

backend framewor microservice microservices nodejs rokkit sample typescript

Last synced: 16 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/rokkit-ts/sample-application
• Owner: rokkit-ts
• License: mit
• Created: 2020-01-25T21:02:26.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-06T17:29:02.000Z (about 2 years ago)
• Last Synced: 2024-11-08T21:36:58.066Z (2 months ago)
• Topics: backend, framewor, microservice, microservices, nodejs, rokkit, sample, typescript
• Language: TypeScript
• Homepage: http://rokkit.dev
• Size: 319 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [Rokkit.ts Sample Application](https://rokkit.dev)

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](https://rokkit.dev/).  

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

```bash

npm i

```

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

```bash

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.

```bash

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.

```bash

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](./LICENSE).