Skip to content

wrtnlabs/autobe-example-reddit

Repository files navigation

AutoBE Generated Backend Server

AutoBE Logo

A backend repository generated by @autobe.

This backend program was automatically generated using @autobe, the AI vibe coding agent for backend servers of below stack.

  • TypeScript
  • NestJS / Nestia
  • Prisma
  • Postgres
flowchart
subgraph "Backend Coding Agent"
  coder("Facade Controller")
end
subgraph "Functional Agents"
  coder --"Requirements Analysis"--> analyze("Analyze")
  coder --"ERD"--> prisma("Prisma")
  coder --"API Design"--> interface("Interface")
  coder --"Test Codes" --> test("Test")
  coder --"Main Program" --> realize("Realize")
end
subgraph "Compiler Feedback"
  prisma --"validates" --> prismaCompiler("Prisma Compiler")
  interface --"validates" --> openapiValidator("OpenAPI Validator")
  interface --"generates" --> tsCompiler("TypeScript Compiler")
  test --"validates" --> tsCompiler("TypeScript Compiler")
  realize --"validates" --> tsCompiler("TypeScript Compiler")
end
Loading

Also, this backend application was built following @autobe's waterfall development model, where each specialized AI agent handles a specific phase of development. The process ensures 100% working code through continuous compiler feedback and validation at every stage.

Each agent receives input from previous phases and produces validated output that becomes the foundation for the next development stage. The Facade Controller orchestrates the entire process, while Functional Agents handle specialized tasks with built-in Compiler Feedback ensuring code quality and correctness.

Below table shows the mapping between waterfall phases, corresponding @autobe agents, and the actual deliverables you can find in this repository:

Waterfall Model AutoBe Agent Result
Requirements Facade Conversation History
Analysis Analyze Requirement Analysis Report
Design Prisma Entity Relationship Diagram / Prisma Schema
Design Interface API Controllers / DTO Structures
Development Realize API Provider Functions
Testing Test E2E Test Functions
Maintenance - Use Claude Code like AI coding tool please

Project Structure

This template project has categorized directories like below.

As you can see from the below, all of the Backend source files are placed into the src directory. When you build the TypeScript source files, compiled files would be placed into the lib directory following the tsconfig.json configuration. Otherwise you build client SDK library for npm publishing and their compiled files would be placed into the packages directory.

NPM Run Commands

List of the run commands defined in the package.json are like below:

  • Test
    • test: Run test automation program
    • benchmark: Run performance benchmark program
  • Build
    • build: Build everything
    • build:main: Build main program (src directory)
    • build:test Build test automation program (test directory)
    • build:sdk: Build SDK into main program only
    • build:swagger: Build Swagger Documents
    • dev: Incremental build for development (test program)
  • Deploy
    • package:api: Build and deploy the SDK library to the NPM
    • start: Start the backend server
    • start:dev: Start the backend server with incremental build and reload
  • Webpack
    • webpack: Run webpack bundler
    • webpack:start: Start the backend server built by webpack
    • webpack:test: Run test program to the webpack built

Specialization

Transform this template project to be yours.

When you've created a new backend project through this template project, you can specialize it to be suitable for you by changing some words. Replace below words through IDE specific function like Edit > Replace in Files (Ctrl + Shift + H), who've been supported by the VSCode.

Before After
ORGANIZATION Your account or corporation name
PROJECT Your own project name
AUTHOR Author name
https://github.com/samchon/nestia-start Your repository URL

License

This backend application was generated by @autobe and is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).

Important Notice: Under AGPL-3.0, any client applications, frontend interfaces, or services that interact with this backend server are also subject to the same AGPL-3.0 licensing requirements. This includes:

  • Web frontends that consume this API
  • Mobile applications connecting to this server
  • Third-party services integrating with this backend
  • Any software that communicates with this server over a network

If you wish to use this backend in proprietary software or avoid open source disclosure obligations, commercial licensing options will be available soon.

Generated by: @autobe - AI-powered no-code backend generator by WrtnLabs

About

About AutoBE Generation Example - Reddit (fake)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published