https://github.com/rxstack/skeleton

a fully-functional skeleton application that you can use for your new applications.
https://github.com/rxstack/skeleton

docker nodejs rxstack skeleton typescript

Last synced: 12 months ago
JSON representation

a fully-functional skeleton application that you can use for your new applications.

• Host: GitHub
• URL: https://github.com/rxstack/skeleton
• Owner: rxstack
• License: mit
• Created: 2018-07-13T10:40:59.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-31T09:18:46.000Z (over 1 year ago)
• Last Synced: 2025-03-27T17:46:14.396Z (12 months ago)
• Topics: docker, nodejs, rxstack, skeleton, typescript
• Language: HTML
• Homepage:
• Size: 1.42 MB
• Stars: 2
• Watchers: 2
• Forks: 2
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# RxStack Skeleton Application

[![Node.js CI](https://github.com/rxstack/skeleton/actions/workflows/node.js.yml/badge.svg)](https://github.com/rxstack/skeleton/actions/workflows/node.js.yml)

[![Maintainability](https://api.codeclimate.com/v1/badges/f6e90ec8ea970b424179/maintainability)](https://codeclimate.com/github/rxstack/skeleton/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/f6e90ec8ea970b424179/test_coverage)](https://codeclimate.com/github/rxstack/skeleton/test_coverage)

> a fully-functional skeleton application that you can use for your new applications.

For more details please visit the [official documentations](https://github.com/rxstack/rxstack).

##  Project folder and file structure

- `src` - all your code lives here

    - `index.ts` - application entry file

    - `cli.ts` - CLI entry file

    - `worker.ts` - worker entry file

    - `app` - application related files

        - `app.ts` - application instance.

        - `APPLICATION_OPTIONS.ts` - all application configurations [read more](https://github.com/rxstack/rxstack/blob/master/packages/core/docs/application.md).

        - `commands` - command line application files [read more](https://github.com/rxstack/rxstack/blob/master/packages/core/docs/console.md).

        - `controllers` - all your controller files [read more](https://github.com/rxstack/rxstack/blob/master/packages/core/docs/kernel.md).

        - `event-listeners` - all your event listener files [read more](https://github.com/rxstack/rxstack/blob/master/packages/async-event-dispatcher).

        - `workers` - worker tasks [read more](https://github.com/rxstack/rxstack/blob/master/packages/worker-threads-pool).

    - `environments` - configuration files [read more](https://github.com/rxstack/rxstack/tree/master/packages/configuration).

- `test` - all tests files

- `static` - all static files

- `eslint.config.mjs` - typescript linter configuration

- `tsconfig.json` - typescript configuration  

##  NPM scripts

- `$ npm run dev` - compiles and starts `nodemon`

- `$ npm run compile` - compiles the source code

- `$ npm run watch` - watching for file changes

- `$ npm run clean` - removes the `dist` directory

- `$ npm run eslint` - lints with eslints

- `$ npm run jest` - runs tests using jest

- `$ npm test` - runs eslint, jest and coverage

- `$ npm run cli` - runs command line applications from `dist` directory

- `$ npm run cli-dev` - runs command line applications with `ts-node`

## License

Licensed under the [MIT license](LICENSE).