feat(examples): add example-with-typeorm (#8143)

This pull request introduces a new typeorm-service package to the
official TurboRepo examples. The aim is to demonstrate the
implementation of a robust service layer using TypeORM with a custom
dependency injection (DI) mechanism. This example is designed to help
developers integrate a more structured backend architecture with their
existing Next.js applications, leveraging TypeORM for ORM capabilities.


<img width="1164" alt="turborepo-orm"
src="https://github.com/vercel/turbo/assets/86150470/2662321f-c5ab-4b26-9623-b48bc611dbaa">

---------

Co-authored-by: Anthony Shew <[email protected]>

examples/with-typeorm/.gitignore

@@ -0,0 +1,38 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# Dependencies
+node_modules
+.pnp
+.pnp.js
+
+# Local env files
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# Testing
+coverage
+
+# Turbo
+.turbo
+
+# Vercel
+.vercel
+
+# Build Outputs
+.next/
+out/
+build
+dist
+
+
+# Debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Misc
+.DS_Store
+*.pem

examples/with-typeorm/README.md

@@ -0,0 +1,106 @@
+# Turborepo with TypeORM
+
+This is an official starter Turborepo configured with TypeORM to manage the service layer in a monorepo setup.
+
+## What's inside?
+
+This Turborepo includes the following packages/apps:
+
+### Apps and Packages
+
+- `docs`: a [Next.js](https://nextjs.org/) app
+- `web`: another [Next.js](https://nextjs.org/) app
+- `ui`: a stub React component library shared by both `web` and `docs` applications
+- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
+- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo
+- `@repo/typeorm-service`: contains the service layer with TypeORM integration to manage database entities and transactions. It utilizes **dependency injection** to provide services across different applications.
+
+## Dependency Injection
+
+The @repo/typeorm-service package demonstrates a sophisticated setup where services are defined using TypeORM repositories and injected into Next.js apps using a custom dependency injection mechanism. This approach emphasizes a clear separation of concerns and a modular architecture.
+
+```typescript
+// root/packages/typeorm-service/domain/todo/todo.repository.ts
+@Repository
+export class TodoRepository {...}
+
+// root/packages/typeorm-service/domain/todo/todo.service.ts
+@InjectAble
+export class TodoService {
+    constructor(private todoRepo: TodoRepository) {}
+    ...
+}
+```
+
+## Example Usage of the Service Layer
+
+This example demonstrates how to use the typeorm-service package to inject and use services within a Next.js app. The TodoService is injected into both page.tsx and API routes.
+
+```typescript
+// root/apps/docs/app/page.tsx
+import { inject, TodoService } from "@repo/typeorm-service";
+
+export default async function Page(): Promise<JSX.Element> {
+  const todoService = inject(TodoService);
+
+  const todoList = await todoService.findAll();
+
+  return ...
+}
+```
+
+In the API route file, TodoService is injected to handle GET and POST requests. The GET request returns the list of todos, while the POST request adds a new todo.
+
+```typescript
+// root/apps/web/app/api/todo/route.ts
+
+import { inject, type Todo, TodoService } from "@repo/typeorm-service";
+
+const todoService = inject(TodoService);
+
+export async function GET() {
+  const list = await todoService.findAll();
+
+  return Response.json(list);
+}
+
+export async function POST(req: Request) {
+  const res: Pick<Todo, "content"> = await req.json();
+
+  const entity = await todoService.add(res.content);
+
+  return Response.json(entity);
+}
+```
+
+## Configuring the Database
+
+For managing the database settings such as the database type, username, password, and other configurations, refer to the orm-config.ts file located in the packages/typeorm-service/src directory. This file centralizes all database connection settings to ensure secure and efficient database management. Make sure to review and adjust these settings according to your environment to ensure optimal performance and security.
+
+```typescript
+// packages/typeorm-service/src/orm-config.ts
+import { DataSource } from "typeorm";
+
+export const AppDataSource = new DataSource({
+    type: "mysql", // or your database type
+    host: "localhost",
+    port: 3306,
+    username: "your_username",
+    password: "your_password",
+    database: "your_database_name",
+    synchronize: true,
+    logging: false,
+    entities: [...],
+    migrations: [...],
+});
+
+```
+
+### Utilities
+
+This Turborepo has some additional tools already setup for you:
+
+- [TypeORM](https://typeorm.io/) for service layer
+- [TypeScript](https://www.typescriptlang.org/) for static type checking
+- [ESLint](https://eslint.org/) for code linting
+- [Prettier](https://prettier.io) for code formatting

examples/with-typeorm/apps/docs/.eslintrc.js

@@ -0,0 +1,9 @@
+/** @type {import("eslint").Linter.Config} */
+module.exports = {
+  root: true,
+  extends: ["@repo/eslint-config/next.js"],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    project: true,
+  },
+};

examples/with-typeorm/apps/docs/README.md

@@ -0,0 +1,28 @@
+## Getting Started
+
+First, run the development server:
+
+```bash
+yarn dev
+```
+
+Open [http://localhost:3001](http://localhost:3001) with your browser to see the result.
+
+You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+
+To create [API routes](https://nextjs.org/docs/app/building-your-application/routing/router-handlers) add an `api/` directory to the `app/` directory with a `route.ts` file. For individual endpoints, create a subfolder in the `api` directory, like `api/hello/route.ts` would map to [http://localhost:3001/api/hello](http://localhost:3001/api/hello).
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn/foundations/about-nextjs) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_source=github.com&utm_medium=referral&utm_campaign=turborepo-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

examples/with-typeorm/apps/docs/app/globals.css

@@ -0,0 +1,50 @@
+:root {
+  --max-width: 1100px;
+  --border-radius: 12px;
+  --font-mono: ui-monospace, Menlo, Monaco, "Cascadia Mono", "Segoe UI Mono",
+    "Roboto Mono", "Oxygen Mono", "Ubuntu Monospace", "Source Code Pro",
+    "Fira Mono", "Droid Sans Mono", "Courier New", monospace;
+
+  --foreground-rgb: 255, 255, 255;
+  --background-start-rgb: 0, 0, 0;
+  --background-end-rgb: 0, 0, 0;
+
+  --callout-rgb: 20, 20, 20;
+  --callout-border-rgb: 108, 108, 108;
+  --card-rgb: 100, 100, 100;
+  --card-border-rgb: 200, 200, 200;
+
+  --glow-conic: conic-gradient(
+    from 180deg at 50% 50%,
+    #2a8af6 0deg,
+    #a853ba 180deg,
+    #e92a67 360deg
+  );
+}
+
+* {
+  box-sizing: border-box;
+  padding: 0;
+  margin: 0;
+}
+
+html,
+body {
+  max-width: 100vw;
+  overflow-x: hidden;
+}
+
+body {
+  color: rgb(var(--foreground-rgb));
+  background: linear-gradient(
+      to bottom,
+      transparent,
+      rgb(var(--background-end-rgb))
+    )
+    rgb(var(--background-start-rgb));
+}
+
+a {
+  color: inherit;
+  text-decoration: none;
+}

examples/with-typeorm/apps/docs/app/layout.tsx

@@ -0,0 +1,22 @@
+import "./globals.css";
+import type { Metadata } from "next";
+import { Inter } from "next/font/google";
+
+const inter = Inter({ subsets: ["latin"] });
+
+export const metadata: Metadata = {
+  title: "Create Turborepo",
+  description: "Generated by create turbo",
+};
+
+export default function RootLayout({
+  children,
+}: {
+  children: React.ReactNode;
+}): JSX.Element {
+  return (
+    <html lang="en">
+      <body className={inter.className}>{children}</body>
+    </html>
+  );
+}