NodArt - The Art of Node.js.
A complete web 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
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
1. GIT
it downloads the current framework version's application with full usage examples.
git clone https://github.com/nodart-labs/nodart-app.git
2. CLI
it creates a base application structure with some usage examples.
npx nodart create-app
it 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')
new App({...config}).init().then(app => {
const server = app.serve(3000, 'http', '127.0.0.1')
server.timeout = 30000
app.setHttpRequestPayload((req, res) => {})
const http = app.service.http()
http.get('url/path/with/:params', (scope) => {})
})
STARTING HTTP SERVICE:
import {App} from "nodart"
const config = require('./config')
const {app, http, server} = new App({...config}).start(3000)
http.get('/path/:first/:second/:+optional_id?', ({route, respond, http}) => {
const {first, second, optional_id} = route.params
const {queryParam} = route.query
respond.send.view('path/to/template', {queryParam})
http.sendFile('path/to/file.png', 'image/png')
respond.send.data({first, second, optional_id}, 200)
return {first, second, optional_id}
})
http.post('/', ({http}) => {
const {someData} = http.data
})
http.post('/', async ({http}) => {
const {fields, files} = await http.form.fetchFormData()
const stat = http.form.stat('field_name')
})
import {SampleService} from "./services/sample"
import {SampleModel} from "./models/sample"
http.get('/', async ({service, model}) => {
const sampleService = service.sample as SampleService
const sampleModel = model.sample as SampleModel
const users = await sampleModel.query.select().table('users')
sampleService.scope.http.send({users})
})
START UNDER DEVELOPMENT SERVER
npm run dev
START UNDER PRODUCTION
npm run start
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-name
npx nodart migrate up | down
Creating 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 latest
Retrieve and return the current migration version
npx nodart migrate version
Return list of completed and pending migrations
npx nodart migrate list
Forcibly unlock the migrations lock table, and ensure that there is only one row in it
npx nodart migrate unlock
DATABASE 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-name
npx nodart seed run
Creating 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 ...
Documentation is processing. The link will be available as soon as possible.