Skip to content

Getting Started

Johan Griesel edited this page Jul 3, 2024 · 15 revisions

The recommended way to get started is with the starter project "dx-sveltekit-starter" which already has Divblox installed and configured, along with some useful basic functionality.

Alternatively, if you want to start from scratch, follow the steps below:

A nodeJS project with a valid package.json file is required.

Note

Your project needs to be using ESM imports. Check that your package.json includes the property "type": "module"

Installation: $ npm install divblox --save-dev

Usage: $ npx divblox --help

Divblox Init

npx divblox -i or npx divblox --init

Initializes your project with the default Divblox folders and files. Read more.

Divblox Sync

npx divblox -s or npx divblox --sync

Synchronizes the provided data model with a configured database. Read More.

Divblox Generate

npx divblox -g or npx divblox --generate

Generates CRUD functionality for the provided entity Read More.

Divblox Data Model

npx divblox -dm or npx divblox --datamodel

Enables the developer to interact with Divblox data models in their local development environment. Read More.

Divblox Help

npx divblox -h or npx divblox --help

Returns a brief overview of the commands and flags available.

Clone this wiki locally