CreatioART: Express Core

CreatioART - Core library package for Express framework it is a Node JS package that contains good practices and reusable base common components. This package can be applied to any web component such as:

• NodeJS Enviroments
• Serverless Engine
• Kubernate Engine
• Node Express Server

Getting Started

1. Quickstart
2. Artifact
3. Requirements
4. Project organization
5. Building from Source
6. Test the Artifact
7. Documentation
8. CreatioART libraries
9. License
10. Change Log

Quickstart

Installing the library

npm install @creatioart-js/express-core

Ways to use

A quick start guide is available.

Templates for use

Service templates are public. README.md file for each template contains instructions for running it.

| Source Code | Status | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | Express Service | | | Express Function | |

Artifact

| Element | Description | | ------------- | --------------------------- | | Artifact id | @creatioart-js/express-core | | Artifact Name | express-core |

Requirements

To build and run the application you need:

• Node.js 20
• Projects must configure TypeScript to use types from the ECMAScript modules that have a:
  • compilerOptions.allowJs should be true.
  • compilerOptions.module should be "node16" or "nodenext".

Project organization

The code is organized as follows:

1. decorator contains the class decorators.
2. dto contains the data transfer object.
3. entity contains the persistence domains.
4. enum contains the enumerations that set the domain values.
5. error contains the error domain values.
6. filter contains the filtering classes.
7. helper contains functionality necessary for general operation.
8. order contains the ordering classes.
9. service contains the interfaces and implementations that define the functionality provided by the service.
10. validation contains the domain validation classes.

Building from Source

1. Install Node.js 20 - Node.js 20 Download
2. Install dependencies: npm install
3. Run compile: npm run build

Test the Artifact

1. Install Node.js 20 - Node.js 20 Download
2. Install dependencies: npm install
3. Run test: npm run test

Documentation

Document Reference: Docs TypeDocs

CreatioART libraries

Complementary libraries available from CreatioART:

Made with ❤️ by the CreatioART team.

• https://www.npmjs.com/org/creatioart-js

Contribute

If you are interested in fixing issues and contributing directly to the code, please contact to the project manager. Here is how you can contribute to CreatioART.express-core:

• Submit bugs and help us verify fixes
• Submit pull requests for bug fixes and features and discuss existing proposals

License

Apache-2.0

Change Log

Change Log