Skip to content

A scaffolding tool for quickly standing up new projects with default structures and best practices.

Notifications You must be signed in to change notification settings

SourceCode/ForgeTS

Repository files navigation

ForgeTS

Production-grade project scaffolding for TypeScript.

ForgeTS is a powerful CLI tool and infrastructure factory designed to accelerate TypeScript development. It provides deterministic, security-first scaffolding for modern applications, handling everything from monorepo structure to strict quality gates.

🚀 Key Features

  • Production-Ready Scaffolding: Generate full-stack TypeScript applications with best practices baked in.
  • Security First: Built-in adherence to NIST 800-53 Rev5 compliance standards (where applicable).
  • Monorepo Support: Optimized for managing multiple packages and applications in a single workspace.
  • Quality Gates: Pre-configured pipelines for strict type checking, linting, and testing.
  • AI-Native: Designed with AI agents in mind, including comprehensive self-documentation (AGENTS.md).

🛠️ Tech Stack

🏁 Quick Start

To get started with ForgeTS locally:

  1. Clone the repository:

    git clone <repository-url>
    cd ForgeTS
  2. Install dependencies:

    pnpm install
  3. Build the project:

    pnpm build
  4. Run the CLI (example):

    # Run the CLI from the package source
    pnpm --filter @forge-ts/cli run start --help

For detailed instructions, see the Installation Guide and First Run Guide.

📚 Documentation

Detailed documentation is available in the docs/ directory.

  • Installation: Prerequisites and detailed setup steps.
  • Setup: Environment configuration and secrets management.
  • Functionality: Core features and capabilities.
  • Architecture: Deep dive into the monorepo structure and components.
  • Testing & Coverage: comprehensive guide to testing strategy and coverage reports.
  • Security: Authentication, authorization, and security practices.
  • Contributing: Guidelines for developers contributing to ForgeTS.

🧪 Testing

We use Vitest for unit and integration testing.

# Run all tests
pnpm test

# Run tests with coverage
pnpm test --coverage

See Testing Documentation for more details.

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details on how to get started.

📄 License

MIT

About

A scaffolding tool for quickly standing up new projects with default structures and best practices.

Resources

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published