Package Exports
- nodart
- nodart/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (nodart) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
NodArt - The Art of Node.js.
A complete framework
for creating microservices and
large-scale server-side applications for businesses
The framework adheres to the concept of "just install and use". Everything you need to run a server application:
- MVC; OOP (TypeScript, ECMAScript 6)
- ORM client, Working with databases (MySQL, PostgresSQL, SQLite, MSSQL, OracleDB, CockroachDB, Amazon Redshift)
- Working with a session
- Templating
- Error and Exception handling
- Working with a command line; Creation of custom commands
- Routing
- Custom events and states
- Dependency injection
- Observer pattern
- Repository pattern
- Module pattern
Everything of this is provided out of the hood. All that is needed for some of the above things to work is to specify the basic settings in the configuration file.
The framework provides a very flexible architecture, making it easy to extend and customize all of these things, up to and including completely changing the basic behavior by specifying class loaders and references in the same configuration file.
The framework is independent, thus it doesn't rely on other frameworks like Express.
APPLICATION CREATION, INITIALISATION AND START
System requirements:
- OS Linux or Windows
- Node.js >= v16.14.2
1. GIT
it downloads the current framework version's application with full usage examples.
git clone https://github.com/nodart-labs/nodart-app.git2. CLI
it creates a base application structure with some usage examples.
npx nodart create-appit creates a microservice application file. Use flag "--js" when you are not using typescript in project.
npx nodart microapp --js[optional]3. INITIALISATION AND START
You can launch microservice or monolithic apps, or you can combine them, depending on the requirements. In this article, you can read more about application architecture.
BASIC INITIALISATION:
import {App} from "nodart"
const config = require('./config')
// Be aware that this fundamental initialization
// automatically creates the necessary app files and folders.
// (database folder, controllers folder, models folder,
// services folder, views folder and etc.)
new App({...config}).init().then(async (app) => {
const server = await app.serve(3000, 'http', '127.0.0.1')
// do anything on startup, for example:
// configure server:
server.timeout = 30000 // setting max timeout on requests
// or create payload for all HTTP requests:
app.service.setRequestPayload((req, res) => {
})
// or launch HTTP service:
const http = app.service.http
http.get('url/path/with/:params', (scope) => {
})
})
STARTING HTTP SERVICE:
import {App} from "nodart"
const config = require('./config')
new App({...config}).start(3000).then(({app, http, server}) => {
// base HTTP processing:
http.get('/path/:first/:second/:+optional_id?', ({route, http}) => {
const {first, second, optional_id} = route.params
const {httpQueryStringParam} = http.query
// sending template from views folder:
http.respond.view('path/to/template/from/views/folder', {queryParam})
// sending file:
http.sendFile('absolute/path/to/file.png', 'image/png')
// sending response JSON:
http.respond.data({first, second, optional_id}, 200)
// or
http.send({first, second, optional_id}, 200, 'application/json')
// or just:
return {first, second, optional_id}
// throwing HttpException. The message will be sent to user.
http.throw(500, 'some error occurred.')
// throwing RuntimeException. The message will not be sent to user,
// but shown in server logs.
http.exit(500, 'some error occurred.', {someData})
})
// fetching data from POST request:
http.post('/', ({http}) => {
const {someData} = http.data
})
// fetching data from POST miltipart/form-data:
http.post('/', async ({http}) => {
const {fields, files} = await http.form.fetchFormData()
const stat = http.form.stat('field_name')
})
// dealing with services and models:
import {SampleService} from "./services/sample"
import {SampleModel} from "./models/subfolder/sample"
http.get('/', async ({service, model}) => {
const sampleService = service().sample as SampleService
const sampleModel = model().subfolder.sample as SampleModel
const users = await sampleModel.query.select().table('users')
sampleService.scope.http.send({users})
})
})
// "./services/sample.ts"
import {Service} from "nodart";
export class SampleService extends Service {
get orm() {
return this.scope.app.service.db.orm // or this.scope.app.get('orm').call()
}
}
CREATION OF CUSTOM SERVER
new App({...config}).init().then(async app => {
const server = await app.serve(3000, 'https', '127.0.0.1', () => {
const fs = require('fs')
const ssl = {
cert: fs.readFileSync('./localhost.crt'),
key: fs.readFileSync('./localhost.key')
}
return require('https').createServer(ssl)
})
})new App({...config}).start(3000, 'http', '127.0.0.1', (app) => {
return require('http').createServer((req, res) => {
app.resolveHttpRequest(req, res)
})
}).then(({app, http, server}) => {
//...
})START UNDER DEVELOPMENT
npm run devSTART UNDER PRODUCTION
npm run startBENCHMARKS
The framework is built on the premise that performance and functionality should be perfectly balanced. The performance of some well-known server-side frameworks is compared here.
Spoiler message: As you can see, the NodArt framework is not far behind the fastest Fastify, and in some aspects surpasses it and all other frameworks.
Environment:
- Computer: AMD Ryzen 5 4600H Radeon, 3000 MHz, 6 Cores, SSD, 16 Gb RAM
- Benchmarking tool: AutoCannon
- Benchmarking command:
autocannon -R 10000 http://localhost:3000
(10000 requests per second; Total connections/users: 10; Total time: 10 seconds)
1. Testing simple JSON response:
http.get('/', () => {
return {hello: "world"}
})| Framework | Bytes/sec | Requests/sec |
|---|---|---|
| Fastify v4.0.0 | 1.91 MB | 10183 |
| NodArt v4.2.0 | 2.02 MB | 10143 |
| Express v4.18.2 | 1.94 MB | 7683 |
| Nest.js v9.0.0 | 1.61 MB | 6395 |
2. Testing parametric route:
http.get('/test/:param1/:param2/:param3/:param4', ({route}) => {
const {param1, param2, param3, param4} = route.params
return {param1, param2, param3, param4}
})| Framework | Bytes/sec | Requests/sec |
|---|---|---|
| Fastify v4.0.0 | 2.27 MB | 10143 |
| NodArt v4.2.0 | 2.45 MB | 10127 |
| Express v4.18.2 | 2.17 MB | 7531 |
| Nest.js v9.0.0 | 1.8 MB | 6239 |
3. Testing static file serve:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<h1>Hello world!</h1>
</body>
</html>| Framework | Bytes/sec | Requests/sec |
|---|---|---|
| NodArt v4.2.0 | 4.4 MB | 7955 |
| Fastify v4.0.0 | 2.32 MB | 5295 |
| Express v4.18.2 | 2 MB | 4343 |
| Nest.js v9.0.0 | 1.87 MB | 4057 |
COMMAND LINE INTERFACE
System Commands:
npx nodart [command name] [command action optional] --[argument name optional] [argument value]App Commands:
node cmd [command name] [command action optional] --[argument name optional] [argument value]DATABASE MIGRATION CLI
Creating and running a Single Migration
npx nodart migrate make --name migration-namenpx nodart migrate up | downCreating and running the Group of Migrations in a single file
npx nodart migrate make-source --name source-name --migrations[optional] migration1 migration2 ...npx nodart migrate source-up | source-down --name source-name --migrations[optional] migration1 migration2 ...Roll back the latest migration
npx nodart migrate rollback --all[optional]Run all migrations that have not yet been run
npx nodart migrate latestRetrieve and return the current migration version
npx nodart migrate versionReturn list of completed and pending migrations
npx nodart migrate listForcibly unlock the migrations lock table, and ensure that there is only one row in it
npx nodart migrate unlockDATABASE SEED CLI
Creates a new seed file, with the name of the seed file being added.
If the seed directory config is an array of paths, the seed file will be generated in the latest specified.
npx nodart seed make --name seed-namenpx nodart seed runCreating and running the Group of Seeds in a single file
npx nodart seed make-source --name source-name --seeds[optional] seed1 seed2 ...npx nodart seed source-run --name source-name --seeds[optional] seed1 seed2 ...