my-steedos-project/
├── package.json              # NPM package configuration (REQUIRED)
├── steedos-config.yml        # Steedos configuration (REQUIRED)
├── .env                      # Environment variables (RECOMMENDED)
├── .gitignore               # Git ignore rules
└── steedos-packages/        # Custom packages (OPTIONAL)
    └── my-package/
        └── ...

{
  "name": "my-steedos-project",
  "version": "0.0.1",
  "private": true,
  "workspaces": [
    "steedos-packages/*"
  ],
  "scripts": {
    "start": "steedos start",
    "build": "lerna run build"
  },
  "dependencies": {
    "@steedos/server": "latest"
  }
}

# Empty file is acceptable
# Or add configuration:
metadata_packages:
  - '@steedos-packages/my-package'

# Server Configuration
PORT=5100
ROOT_URL=http://localhost:5100

# Database
MONGO_URL=mongodb://127.0.0.1:27017/steedos

# Message Queue & Cache
TRANSPORTER=redis://127.0.0.1:6379
CACHER=redis://127.0.0.1:6379/1

# Storage
STEEDOS_STORAGE_DIR=./steedos-storage

# Logging
B6_LOG_LEVEL=warn

my-steedos-project/
├── package.json                      # NPM configuration
├── steedos-config.yml                # Steedos configuration
├── .env                              # Environment variables
├── .gitignore                        # Git ignore
├── yarn.lock / package-lock.json    # Dependency lock file
├── node_modules/                     # Dependencies
├── steedos-storage/                  # File storage
└── steedos-packages/                 # Custom packages
    ├── package-1/
    │   ├── package.json
    │   ├── package.service.js
    │   └── main/default/
    │       ├── objects/
    │       ├── applications/
    │       ├── triggers/
    │       └── pages/
    └── package-2/
        └── ...

mkdir my-steedos-project
cd my-steedos-project

npm init -y
# Edit package.json to add required fields

touch steedos-config.yml

cat > .env << EOF
PORT=5100
ROOT_URL=http://localhost:5100
MONGO_URL=mongodb://127.0.0.1:27017/steedos
TRANSPORTER=redis://127.0.0.1:6379
CACHER=redis://127.0.0.1:6379/1
STEEDOS_STORAGE_DIR=./steedos-storage
B6_LOG_LEVEL=warn
EOF

npm install @steedos/server
# or
yarn add @steedos/server

npm start
# or
steedos start

# Install CLI
npm install -g @steedos/cli

# Create project
steedos create my-project
cd my-project

# Start
npm start

{
  "name": "my-steedos-project",
  "private": true,
  "workspaces": [
    "steedos-packages/*"
  ]
}

# Dependencies
node_modules/
.yarn/
.pnp.*

# Environment
.env
.env.local

# Storage
steedos-storage/
.steedos/

# Logs
logs/
*.log

# Build
dist/
build/
.cache/

# IDE
.vscode/
.idea/
*.swp
*.swo

# Start development server
npm start

# Build packages
npm run build

# Install dependencies
npm install
# or
yarn install

# Add new package
cd steedos-packages
mkdir my-package
cd my-package
npm init -y