fe258e589510b4a100418184daa9ea56c24dd614
Feature: Migrate to Typescript7 & AdonisJs7 See merge request crux/admin!27
Tech Stack
Backend
- AdonisJS
- TypeScript
- Lucid ORM
- PostgreSQL / MySQL (configurable)
Frontend
- React
- TypeScript
- Vite
- React Query / Mobx / Axios
- Component-based UI system
Getting Started
Prerequisites
Node.js >= v24.18.0 npm >= 11.15.0 Database PostgreSQL
Installation
git clone gitlab@git.rexsoftproduction.com:crux/admin.git
cd crux
npm install
Configuration
Environment variables are defined in root .env
TZ=UTC
PORT=3333
HOST=localhost
LOG_LEVEL=info
APP_KEY=
NODE_ENV=development
DB_HOST=127.0.0.1
DB_PORT=5432
DB_USER=postgres
DB_PASSWORD=postgres
DB_DATABASE=adonis
VITE_API_URL=http://0.0.0.0:3333
VITE_TINYMCE_API_KEY=
Module Generator
The module generator allows you to create full CRUD modules by selecting:
- Database table
- Fields and types
- Validation rules
- List view configuration
Generated Output
Backend: controllers, validators, routes Frontend: pages, forms, tables, API
Authentication & Authorization
- JWT / Session-based authentication
- Role & permission system
- Policy-based access control
Scripts
Development
| Command | Description |
|---|---|
npm run dev:backend |
Start the AdonisJS backend in development mode |
npm run dev:admin-app |
Start the React admin application |
npm run dev:all |
Start backend and admin app concurrently |
Build
| Command | Description |
|---|---|
npm run build:backend |
Build the backend application |
npm run build:admin |
Build the admin application |
Versions
| Command | Description |
|---|---|
npm run patch |
Update Patch version of all packages |
npm run minor |
Update Minor version of all packages |
npm run major |
Update Major version of all packages |
Versions are updated without creating git tags.
Languages
TypeScript
50.7%
HTML
42.5%
CSS
6.1%
Handlebars
0.4%
JavaScript
0.3%