Understanding the Role of the Scripts Directory in AiToEarn Development

The scripts directory in AiToEarn serves as a lightweight utility hub for development workflow automation, handling platform initialization, Docker image construction, and isolated dependency management outside the main application codebase.

The AiToEarn platform maintains a dedicated scripts directory at the repository root to house operational utilities that support development, provisioning, and containerization workflows. Unlike the main application source code located in project/, this directory contains standalone scripts designed for invocation by Docker, CI pipelines, and developers without requiring the full monorepo build toolchain.

Core Responsibilities of the AiToEarn Scripts Directory

The scripts folder fulfills three critical infrastructure roles that streamline the development lifecycle.

Platform Initialization via init.mjs

The scripts/init.mjs file handles automated bootstrapping of fresh AiToEarn environments. This Node.js module creates a default administrative user in MongoDB, generates a permanent JWT token for automatic authentication, and writes the resulting token to a configurable filesystem path defined by the AUTO_LOGIN_TOKEN_PATH environment variable. According to the AiToEarn source code, this script is referenced in docker-compose.yml (lines 83-84) and executes as the aitoearn-init service when initializing new deployments.

Docker Image Construction with build.sh

The scripts/build.sh Bash script provides a streamlined interface for building all service Docker images locally without pushing to remote registries. This helper supplies the working directory context to scripts/build-docker.mjs, an Nx utility script used by backend workspace targets to generate container artifacts. By isolating this build logic, developers can produce images independently of the full Nx workspace initialization.

Isolated Dependency Management in init-package.json

The scripts/init-package.json file declares a minimal Node.js runtime configuration ("type": "module") and pins essential dependencies including mongodb and jsonwebtoken. This self-contained package definition enables the initialization container to execute with a tiny Node environment, keeping secret-handling and token-generation logic physically separated from the main AiToEarn application codebase while remaining accessible to infrastructure orchestrators.

Practical Implementation Examples

These utilities integrate directly into Docker workflows and support manual execution for development scenarios.

Bootstrapping a Fresh Environment

To manually execute the initialization logic outside of Docker, install the minimal dependencies and invoke the script directly:

# Install dependencies defined in init-package.json

npm ci --prefix scripts

# Execute initialization (creates admin user and generates token)

node scripts/init.mjs

Alternatively, trigger the initialization via Docker Compose using the aitoearn-init service definition:

services:
  aitoearn-init:
    image: node:20-alpine
    volumes:
      - ./scripts/init.mjs:/app/init.mjs:ro
      - ./scripts/init-package.json:/app/package.json:ro
    command: ["node", "/app/init.mjs"]

Running docker compose up aitoearn-init automatically seeds the MongoDB instance and emits the authentication token to the configured path.

Local Docker Build Execution

To build all AiToEarn service images locally without CI infrastructure:

# From repository root

./scripts/build.sh

This script iterates through each service (backend, web, electron, and others) and invokes the Nx-provided scripts/build-docker.mjs helper to produce local Docker images ready for testing.

Summary

• The scripts directory provides isolated utility scripts for AiToEarn development operations, deliberately separated from the main application source in project/.
• scripts/init.mjs automates database seeding and JWT token generation for fresh deployments, referenced directly in docker-compose.yml.
• scripts/build.sh enables local Docker image construction without involving the full Nx workspace build system.
• scripts/init-package.json maintains minimal dependencies for the initialization script, ensuring lightweight container execution.

Frequently Asked Questions

What does scripts/init.mjs do in AiToEarn?

The scripts/init.mjs file initializes new AiToEarn deployments by creating a default admin user in MongoDB, generating a permanent JWT authentication token, and writing that token to a configurable path. This script runs automatically as the aitoearn-init service when using Docker Compose, or can be executed manually using Node.js.

Why is the scripts directory separate from the main project folder?

The separation ensures that Docker containers, CI pipelines, and developers can invoke initialization and build utilities without importing the full monorepo build toolchain or application source code. This architectural isolation keeps the operational scripts lightweight and prevents circular dependencies between infrastructure tooling and application logic.

How do I run the initialization script manually?

Execute npm ci --prefix scripts to install the minimal dependencies declared in init-package.json, then run node scripts/init.mjs from the repository root. The script requires environment variables for MongoDB connection and the AUTO_LOGIN_TOKEN_PATH destination for the generated JWT.

What dependencies are required for the init script?

According to scripts/init-package.json, the initialization script requires only two production dependencies: mongodb for database connectivity and jsonwebtoken for JWT generation. These are isolated from the main application's dependency tree to maintain a minimal container footprint.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}