README.md

ArtusX

Ecosystem based on Artus.js - https://www.artusjs.org.

Packages

packages	Version
libs
@artusx/core
@artusx/otl
@artusx/utils
tools
@artusx/init
@artusx/init-config
@artusx/tsconfig
@artusx/eslint-config
@artusx/rush-utils
plugins
@artusx/plugin-koa
@artusx/plugin-nest
@artusx/plugin-express
@artusx/plugin-redis
@artusx/plugin-log4js
@artusx/plugin-ejs
@artusx/plugin-nunjucks
@artusx/plugin-schedule
@artusx/plugin-grpc
@artusx/plugin-pptr
@artusx/plugin-proxy
@artusx/plugin-openai
@artusx/plugin-telegram
@artusx/plugin-socketio
@artusx/plugin-xtransit
@artusx/plugin-sequelize
@artusx/plugin-prometheus
@artusx/plugin-clickhouse
boilerplates
@artusx/boilerplate-artusx-app
@artusx/boilerplate-artusx-lib
@artusx/boilerplate-artusx-plugin

Quickstart

install @artusx/init

npm i -g @artusx/init

create web app with app boilerplate

artusx-init --name web --type apps

install deps and run the app

cd web
pnpm i
pnpm run dev

Development

prepare

install rush.js

npm install -g @microsoft/rush

install deps

rush update

create new package

# build generator tools
rush rebuild -t @artusx/init

# create new package and update projects in rush.json
rush create --name web --type apps --rush
rush create --name common --type libs --rush
rush create --name postgres --type plugins --rush

release

publish to npm.js

# export npm auth token
export NPM_AUTH_TOKEN={NPM_AUTH_TOKEN}

# update changelog
rush changelog

# 1.1 publish with actions
# 1.1.1 update version
rush version --bump

# 1.1.2 release lockStepVersion
# git release {version} -m "chore: release {version}"
# git release v1.0.12 -m "chore: release 1.0.12"
rush release-package

# 1.2 release individualVersion
# git release v1.1.5-rc.12 -m "chore: release 1.1.5-rc.12"
rush release-package -r # rush release-package --prerelease

# 2. publish with rush.js
# rush publish --include-all --publish
rush publish-package

License

MIT