Deenruv Create

A CLI tool for rapidly scaffolding a new Deenruv server application with a React admin panel. Heavily inspired by create-react-app.

The generated project uses PostgreSQL as its database and ships with:

• A server application (NestJS + GraphQL)
• A React admin panel (Vite + React) powered by @deenruv/admin-dashboard

Usage

Deenruv Create requires Node.js v18+ to be installed and a running PostgreSQL instance.

To create a new project, you may choose one of the following methods:

npx

npx @deenruv/create my-app

npx comes with npm 5.2+ and higher.

npm

npm init @deenruv my-app

npm init <initializer> is available in npm 6+

Yarn

yarn create @deenruv my-app

yarn create is available in Yarn 0.25+

It will create a directory called my-app inside the current folder containing:

• Server source code in src/
• React admin panel in admin/

Generated Project Structure

my-app/
├── src/                    # Server source (NestJS + GraphQL)
│   ├── index.ts            # Server entry point
│   ├── index-worker.ts     # Worker entry point
│   ├── deenruv-config.ts   # Server configuration
│   └── plugins/            # Custom plugins directory
├── admin/                  # React admin panel (Vite + React)
│   ├── src/
│   │   ├── main.tsx        # React entry point
│   │   └── App.tsx         # Main App component
│   ├── index.html
│   ├── vite.config.ts
│   └── package.json
├── static/                 # Static assets and email templates
├── package.json
├── .env
├── Dockerfile
├── docker-compose.yml
└── README.md

Development

After creating your project:

cd my-app
npm run dev    # Starts server, worker, and admin panel concurrently

• Admin API: http://localhost:6100/admin-api
• Shop API: http://localhost:6100/shop-api
• Admin UI: http://localhost:6101/admin-ui

Options

--use-npm

By default, Deenruv Create will detect whether a compatible version of Yarn is installed, and if so will display a prompt to select the preferred package manager. You can override this and force it to use npm with the --use-npm flag.

--log-level

You can control how much output is generated during the installation and setup with this flag. Valid options are silent, info and verbose. The default is silent

Example:

npx @deenruv/create my-app --log-level verbose