chore: update readme

Author: RomainLanz

README.md

@@ -9,7 +9,7 @@
   </p>
 
   <p>
-    Choose the right foundation for your next project based on your preferred frontend approach.
+    Choose the right foundation for your next project based on your preferred architecture.
   </p>
 
   <br>
@@ -29,11 +29,12 @@
 
 ## 📦 Available Starter Kits
 
-This repository contains the official AdonisJS starter kits, each tailored for different frontend approaches and use cases.
+This repository contains the official AdonisJS starter kits, each tailored for different architectures and use cases.
 
 | Starter Kit | Description | Best For |
 |-------------|-------------|----------|
-| [**API**](./api) | Type-safe REST API with dual authentication (tokens & sessions) | Building APIs for any frontend, mobile apps, third-party integrations |
+| [**API**](./api) | Standalone type-safe REST API with dual authentication (tokens & sessions) | Backend-only services, mobile apps, third-party integrations |
+| [**API Monorepo**](./api-monorepo) | API backend + dedicated frontend workspace in a monorepo | Full-stack teams that want backend and frontend in the same repository |
 | [**Hypermedia**](./hypermedia) | Server-rendered applications with Edge.js templates and Alpine.js | Traditional web apps, admin panels, content sites |
 | [**Inertia React**](./inertia-react) | Single-page applications with React and Inertia.js | Modern SPAs with React ecosystem |
 | [**Inertia Vue**](./inertia-vue) | Single-page applications with Vue and Inertia.js | Modern SPAs with Vue ecosystem |
@@ -44,7 +45,7 @@ This repository contains the official AdonisJS starter kits, each tailored for d
 
 ### API Starter Kit
 
-Build type-safe REST APIs with dual authentication (API tokens and sessions) that work with any frontend framework.
+Build a standalone, type-safe REST API with dual authentication (API tokens and sessions).
 
 ```bash
 npm init adonisjs@latest -- -K=api
@@ -56,6 +57,20 @@ npm init adonisjs@latest -- -K=api
 
 ---
 
+### API Monorepo Starter Kit
+
+Build a full-stack monorepo with an AdonisJS API backend and a dedicated frontend workspace.
+
+```bash
+npm init adonisjs@latest -- -K=api-monorepo
+```
+
+**Includes:** API backend workspace, frontend workspace scaffold, Turborepo orchestration, shared type-safe API integration with Tuyau
+
+[Learn more about API Monorepo →](./api-monorepo)
+
+---
+
 ### Hypermedia Starter Kit
 
 Build server-rendered applications with Edge.js templating and progressive enhancement using Alpine.js.
@@ -112,6 +127,13 @@ During setup, select `vue` as your frontend adapter.
 - Flexible authentication (API tokens for cross-origin, sessions for same-domain)
 - Framework-agnostic API-first architecture
 
+### Choose API Monorepo if you want:
+
+- Keep your backend API and frontend app in the same repository
+- Share types and API contracts across workspaces
+- Run development, test, and build workflows from one monorepo toolchain
+- Start with an API-first backend plus a dedicated frontend workspace
+
 ### Choose Hypermedia if you want:
 
 - Fast initial page loads with server-side rendering

api-monorepo/README.md

@@ -0,0 +1,42 @@
+<div align="center">
+
+  <h1>API Monorepo Starter Kit</h1>
+
+  <p>
+    <strong>A dedicated AdonisJS monorepo starter with an API backend and a frontend workspace.</strong>
+  </p>
+
+</div>
+
+---
+
+## ✨ What's in the Box
+
+- **API backend workspace** in `apps/backend` (AdonisJS + authentication + Tuyau)
+- **Frontend workspace** in `apps/frontend` (intentionally empty, bring your own framework)
+- **Monorepo tooling** with Turborepo and workspaces for coordinated scripts
+
+---
+
+## 🚀 Quick Start
+
+```bash
+npm init adonisjs@latest -- -K=api-monorepo
+```
+
+Then from your generated project:
+
+```bash
+# Install dependencies
+npm install
+
+# Run all workspace development scripts
+npm run dev
+```
+
+---
+
+## 📁 Workspaces
+
+- [Backend workspace docs](./apps/backend/README.md)
+- [Frontend workspace docs](./apps/frontend/README.md)

api-monorepo/apps/backend/README.md

@@ -1,13 +1,13 @@
 <div align="center">
 
-  <h1>API Starter Kit</h1>
+  <h1>API Monorepo Starter Kit - Backend Workspace</h1>
 
   <p>
-    <strong>A batteries-included AdonisJS starter kit for building modern, type-safe APIs.</strong>
+    <strong>The backend workspace for the AdonisJS API Monorepo starter kit.</strong>
   </p>
 
   <p>
-    Built for developers who want a production-ready API with any frontend framework.
+    Built for teams who want a production-ready API inside a full-stack monorepo.
   </p>
 
   <br>
@@ -27,7 +27,7 @@
 
 ## ✨ What's in the Box
 
-This starter kit is designed to help you build production-ready APIs with AdonisJS. It provides a solid foundation with authentication, type-safe routes, and everything you need to build modern APIs that work with any frontend framework.
+This backend workspace is designed to help you build production-ready APIs with AdonisJS. It provides a solid foundation with authentication, type-safe routes, and everything you need to power any frontend from a shared monorepo.
 
 ### 🎯 Core Features
 
@@ -148,7 +148,7 @@ Your API will be running at `http://localhost:3333`
 - `POST /api/v1/auth/signup` - Create a new account
 - `POST /api/v1/auth/login` - Login and get access token
 - `POST /api/v1/auth/logout` - Logout (requires authentication)
-- `GET /api/v1/me` - Get current user (requires authentication)
+- `GET /api/v1/account/profile` - Get current user profile (requires authentication)
 
 ---
 
@@ -219,7 +219,7 @@ You can easily switch between strategies by changing the guard in your middlewar
 
 ## 🤝 Contributing
 
-This starter kit is maintained by the AdonisJS team. Found a bug or have a suggestion? [Open an issue](https://github.com/adonisjs/api-starter-kit/issues) or submit a pull request!
+This starter kit is maintained by the AdonisJS team. Found a bug or have a suggestion? [Open an issue](https://github.com/adonisjs/starter-kits/issues) or submit a pull request!
 
 ---
 

api-monorepo/apps/frontend/README.md

@@ -1,6 +1,6 @@
 # Frontend Workspace
 
-This is an **empty frontend starter** for the AdonisJS API Starter Kit. You can set up any frontend application to consume the type-safe API from the backend.
+This is an **empty frontend starter** for the AdonisJS API Monorepo Starter Kit. You can set up any frontend application to consume the type-safe API from the backend.
 
 ## 🎯 Purpose
 

api/README.md

@@ -7,7 +7,7 @@
   </p>
 
   <p>
-    Built for developers who want a production-ready API with any frontend framework.
+    Built for developers who want a production-ready standalone API.
   </p>
 
   <br>
@@ -38,7 +38,6 @@ This starter kit is designed to help you build production-ready APIs with Adonis
 - **🛡️ Security First** - CORS, Shield middleware, and secure authentication
 - **🔒 Type Safety** - End-to-end TypeScript with Tuyau for type-safe API calls
 - **🌐 CORS Ready** - Pre-configured for cross-origin requests
-- **📦 Monorepo** - Built with Turborepo and npm workspaces for optimal DX
 
 ### 🔧 Tech Stack
 
@@ -85,48 +84,36 @@ This starter kit is designed to help you build production-ready APIs with Adonis
       Full TypeScript support with strict mode enabled
     </td>
   </tr>
-  <tr>
-    <td><strong>Monorepo</strong></td>
-    <td>
-      <a href="https://turbo.build">Turborepo</a> + npm workspaces
-    </td>
-  </tr>
 </table>
 
 ---
 
 ## 🚀 Quick Start
 
-### From the Monorepo Root
+### From the Project Root
 
 ```bash
 # Install dependencies
 npm install
 
-# Run the development server (both backend and frontend)
-npm run dev
+# Copy environment variables
+cp .env.example .env
 
-# Run tests
-npm run test
+# Generate application key
+node ace generate:key
 
-# Type check all apps
-npm run typecheck
+# Run database migrations
+node ace migration:run
 
-# Lint all apps
-npm run lint
-
-# Build for production
-npm run build
+# Run the development server with hot reload
+npm run dev
 ```
 
-### Backend Only (from apps/backend)
+### Useful Commands
 
 ```bash
-# Run the development server with hot reload
-node ace serve --hmr
-
 # Run tests
-node ace test
+npm run test
 
 # Type check
 npm run typecheck
@@ -148,7 +135,7 @@ Your API will be running at `http://localhost:3333`
 - `POST /api/v1/auth/signup` - Create a new account
 - `POST /api/v1/auth/login` - Login and get access token
 - `POST /api/v1/auth/logout` - Logout (requires authentication)
-- `GET /api/v1/me` - Get current user (requires authentication)
+- `GET /api/v1/account/profile` - Get current user profile (requires authentication)
 
 ---
 
@@ -181,9 +168,9 @@ Your API will be running at `http://localhost:3333`
   </tr>
   <tr>
     <td>
-      <a href="https://turbo.build"><strong>📦 Turborepo</strong></a>
+      <a href="https://docs.adonisjs.com/guides/authentication/introduction"><strong>🔐 Authentication Guide</strong></a>
       <br>
-      <span>Monorepo build system</span>
+      <span>Sessions and access tokens in AdonisJS</span>
     </td>
     <td>
       <a href="https://docs.adonisjs.com/guides/security/cors"><strong>🌐 CORS Guide</strong></a>