struxjs-core
v1.0.12
Published
The elegant, production-ready core engine for the StruxJS framework, featuring a flexible IoC Container, Active Record ORM, and high-performance HTTP routing wrapped over Fastify.
Maintainers
Readme
What is this?
This repository contains the Core Engine of the StruxJS framework. It includes the IoC Container, the Active Record ORM, the HTTP Router (Fastify wrapper), and all fundamental services (Mail, Queue, Cache, Session, Broadcasting).
If you are looking to start a new StruxJS project, DO NOT install this package manually. Instead, use our official scaffolding CLI:
npx create-struxjs-app my-awesome-projectVisit the Official Documentation to learn more about building applications with StruxJS.
Manual Installation
If you are building an extension or a custom integration and need to install the core package directly:
npm install struxjs-coreContributing to the Core
We welcome contributions to the StruxJS Core Engine!
- Clone the main monorepo:
git clone https://github.com/Strux-Team/struxjs.git - Navigate to this package:
cd strux-core - Install dependencies from the root:
npm install - Compile your TypeScript changes:
npm run build
For active local development, we recommend running the sandbox application at the root of the monorepo, which automatically live-reloads changes made to this core package.
License
The StruxJS Core is open-sourced software licensed under the MIT license.
