https://github.com/wrtnlabs/autobe-example-bbs
AutoBE Generation Example - BBS (Bullet-in Board System)
https://github.com/wrtnlabs/autobe-example-bbs
Last synced: 3 months ago
JSON representation
AutoBE Generation Example - BBS (Bullet-in Board System)
- Host: GitHub
- URL: https://github.com/wrtnlabs/autobe-example-bbs
- Owner: wrtnlabs
- License: mit
- Created: 2025-06-09T15:59:52.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-06-09T16:31:27.000Z (4 months ago)
- Last Synced: 2025-06-09T17:20:08.588Z (4 months ago)
- Language: TypeScript
- Size: 536 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AutoBE Generated Backend Server
A backend repository generated by [`@autobe`](https://github.com/wrtnlabs/autobe).
This backend program was automatically generated using [`@autobe`](https://github.com/wrtnlabs/autobe), the AI vibe coding agent for backend servers of below stack.
- TypeScript
- NestJS / Nestia
- Prisma
- Postgres
## 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](src/) directory. When you build the TypeScript source files, compiled files would be placed into the `lib` directory following the [tsconfig.json](tsconfig.json) configuration. Otherwise you build client [SDK](#32-sdk) library for npm publishing and their compiled files would be placed into the [packages](packages) directory.
- [packages/api/](packages/api): SDK module built by `npm run build:api`
- [src/](src): Backend source directory
- [src/api/](src/api/): Client SDK that would be published to the `@ORGANIZATION/PROJECT-api`
- [**src/api/functional/**](src/api/functional/): API functions generated by the [`nestia`](https://github.com/samchon/nestia)
- [**src/api/structures/**](src/api/structures/): DTO structures
- [src/controllers/](src/controllers/): Controller classes of the Main Program
- [**test/**](test): Test Automation Program
- [test/features](test/features): List of test functions
- [nestia.config.ts](nestia.config.ts): Configuration file of [`nestia`](https://github.com/samchon/nestia)
- [package.json](package.json): NPM configuration
- [tsconfig.json](tsconfig.json): TypeScript configuration for the main program
## NPM Run Commands
List of the run commands defined in the [package.json](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