Skip to content

setup.md

Latest commit

 

History

History
45 lines (29 loc) · 1.4 KB

setup.md

File metadata and controls

45 lines (29 loc) · 1.4 KB

Setup & Configuration

Environment Variables

ForgeTS uses a robust configuration system. While the core CLI might not require a global .env file for basic operations, specific modules or development tasks may require one.

Global Configuration

Check for a .env.example in the root directory. If present, copy it to .env:

cp .env.example .env
Variable Description Required Default
NODE_ENV Environment mode (development, production, test) No development
LOG_LEVEL Logging verbosity (debug, info, warn, error) No info

Package-Specific Configuration

Each package in packages/ may have its own configuration requirements. Refer to the README.md within specific packages if you are working on them individually.

Secrets Management

Warning

Never commit real secrets (API keys, passwords, tokens) to version control.

  • Local Development: Use .env files which are git-ignored.
  • CI/CD: Configure secrets in your CI provider (e.g., GitHub Actions Secrets).

Build Configuration

The project uses TypeScript project references.

  • Root tsconfig.json: Orchestrates the build across the monorepo.
  • Base tsconfig.base.json: Contains shared compiler options.

To rebuild the project after configuration changes:

# Clean and rebuild
pnpm run clean
pnpm run build