AdonisJS

https://v6-docs.adonisjs.com/guides/
Admin
AdonisJS is a TypeScript-first web framework for Node.js that provides structure, tools, and...
Tokens:369,302
Snippets:3,404
Trust Score:10
Update:12 hours ago
Show doc for...
Tokens:
Raw
### start method with environment checks

Source: https://v6-docs.adonisjs.com/guides/concepts/service-providers

The `start` method is called after `boot` and before `ready`. It allows you to perform actions that the `ready` hook might need. This example shows how to check the application environment.

```typescript
export default class AppProvider {
  async start() {
    if (this.app.getEnvironment() === 'web') {
    }

    if (this.app.getEnvironment() === 'console') {
    }

    if (this.app.getEnvironment() === 'test') {
    }

    if (this.app.getEnvironment() === 'repl') {
    }
  }
}
```

--------------------------------

### Initialize npm project

Source: https://v6-docs.adonisjs.com/guides/concepts/async-local-storage

Creates a new Node.js project with default settings. Run this command in an empty directory to start the example.

```shellscript
npm init --yes
```

--------------------------------

### Run production build

Source: https://v6-docs.adonisjs.com/guides/concepts/typescript-build-process

After building, change into the `build` directory, install production dependencies, and run the server. The example uses `npm ci --omit=dev` and `node bin/server.js`.

```shellscript
cd build

# Install production dependencies
npm ci --omit=dev

# Run server
node bin/server.js
```

--------------------------------

### Install @adonisjs/limiter package

Source: https://v6-docs.adonisjs.com/guides/security/rate-limiting

Run this command to install and configure the @adonisjs/limiter package. It installs the package, registers the service provider, creates config and start files, and defines the LIMITER_STORE environment variable.

```shellscript
node ace add @adonisjs/limiter
```

--------------------------------

### Create a preload file with make:preload

Source: https://v6-docs.adonisjs.com/guides/references/commands

Creates a new preload file in the start directory. The example creates a preload file named 'view'.

```shellscript
node ace make:preload view
```

--------------------------------

### Get start directory path with app.startPath

Source: https://v6-docs.adonisjs.com/guides/concepts/application

Returns path to a file inside the start directory. Without arguments, returns the start directory path.

```typescript
app.startPath('routes.ts')
// /project_root/start/routes.ts

app.startPath()
// /project_root/start
```

--------------------------------

### Install and configure a package with `node ace add`

Source: https://v6-docs.adonisjs.com/guides/references/commands

The `add` command installs and configures a package in one step. It automatically detects the package manager, but you can override it with `--package-manager`. Use `--dev` to install as a development dependency.

```shellscript
# Install and configure the @adonisjs/lucid package
node ace add @adonisjs/lucid

# Install the package as a development dependency and configure it
node ace add my-dev-package --dev
```

--------------------------------

### Render a table in an ace command

Source: https://v6-docs.adonisjs.com/guides/testing/console-tests

Example of an ace command's run method that creates a table with headers and rows, then renders it. This is the setup for testing table output.

```typescript
async run() {
  const table = this.ui.table()
  table.head(['Name', 'Email'])

  table.row(['Harminder Virk', 'virk@adonisjs.com'])
  table.row(['Romain Lanz', 'romain@adonisjs.com'])
  table.row(['Julien-R44', 'julien@adonisjs.com'])
  table.row(['Michaël Zasso', 'targos@adonisjs.com'])

  table.render()
}
```

--------------------------------

### Start PM2 server with ecosystem file

Source: https://v6-docs.adonisjs.com/guides/getting-started/deployment

Command to start the production server using PM2 with the ecosystem.config.js file.

```shellscript
pm2 start ecosystem.config.js
```

--------------------------------

### Install BullMQ

Source: https://v6-docs.adonisjs.com/guides/digging-deeper/mail

Install the `bullmq` package to use a Redis-backed queue for email jobs.

```shellscript
npm i bullmq
```

--------------------------------

### Install @adonisjs/drive

Source: https://v6-docs.adonisjs.com/guides/digging-deeper/drive

Run this command to install and configure the @adonisjs/drive package. It installs the package, registers the service provider, creates the config file, and sets up environment variables.

```shellscript
node ace add @adonisjs/drive
```

--------------------------------

### Install @adonisjs/i18n package

Source: https://v6-docs.adonisjs.com/guides/digging-deeper/i18n

Run this command to install and configure the @adonisjs/i18n package. It installs the package, registers the service provider, creates the config file and middleware, and registers the middleware in the kernel.

```shellscript
node ace add @adonisjs/i18n
```

--------------------------------

### Install @adonisjs/prettier-config and prettier

Source: https://v6-docs.adonisjs.com/guides/concepts/tooling-config

Install the Prettier config package and prettier itself.

```shellscript
npm i -D @adonisjs/prettier-config

# Make sure also to install prettier
npm i -D prettier
```

--------------------------------

### Install Lucid with node ace add @adonisjs/lucid

Source: https://v6-docs.adonisjs.com/guides/database/lucid

Run this command to install and configure Lucid. It registers the service provider and commands, creates config/database.ts, defines environment variables, and installs peer dependencies.

```shellscript
node ace add @adonisjs/lucid
```

--------------------------------

### Install @adonisjs/otel with node ace add

Source: https://v6-docs.adonisjs.com/guides/digging-deeper/open-telemetry

Run this command to install and configure the package. It creates `otel.ts`, adds the import to `bin/server.ts`, registers the provider and middleware, and sets up environment variables.

```shellscript
node ace add @adonisjs/otel
```

--------------------------------

### Install and configure @adonisjs/vite

Source: https://v6-docs.adonisjs.com/guides/basics/vite

Run this command to install the @adonisjs/vite package and Vite, and to configure the project by creating the necessary configuration files.

```shellscript
node ace add @adonisjs/vite
```

--------------------------------

### Install and configure VineJS with node ace add vinejs

Source: https://v6-docs.adonisjs.com/guides/basics/validation

Run this command to install and configure VineJS. It installs the `@vinejs/vine` package and registers the VineJS service provider in `adonisrc.ts`.

```shellscript
node ace add vinejs
```

--------------------------------

### Install @japa/api-client package

Source: https://v6-docs.adonisjs.com/guides/testing/http-tests

Install the API client plugin as a dev dependency using npm.

```shellscript
npm i -D @japa/api-client
```

--------------------------------

### Install @adonisjs/eslint-config and eslint

Source: https://v6-docs.adonisjs.com/guides/concepts/tooling-config

Install the ESLint config package and eslint itself.

```shellscript
npm i -D @adonisjs/eslint-config

# Make sure also to install eslint
npm i -D eslint
```

--------------------------------

### Install @adonisjs/session package

Source: https://v6-docs.adonisjs.com/guides/basics/session

Run this command to install and configure the session package. It automatically installs the package, registers the provider and command, creates the config file, sets environment variables, and registers the middleware.

```shellscript
node ace add @adonisjs/session
```

--------------------------------

### Install nodemailer and nodemailer-postmark-transport

Source: https://v6-docs.adonisjs.com/guides/digging-deeper/mail

Install the required packages for creating a custom transport using the Postmark transport.

```shellscript
npm i nodemailer nodemailer-postmark-transport
```

--------------------------------

### Install @adonisjs/static package

Source: https://v6-docs.adonisjs.com/guides/basics/static-file-server

Run this command to install and configure the @adonisjs/static package. The add command also registers the service provider, creates config/static.ts, and registers the middleware.

```shellscript
node ace add @adonisjs/static
```

--------------------------------

### Install @adonisjs/auth with different guards

Source: https://v6-docs.adonisjs.com/guides/authentication/introduction

Commands to install and configure the auth package with the session (default), access tokens, or basic auth guard.

```shellscript
# Configure with session guard (default)
node ace add @adonisjs/auth --guard=session

# Configure with access tokens guard
node ace add @adonisjs/auth --guard=access_tokens

# Configure with basic auth guard
node ace add @adonisjs/auth --guard=basic_auth
```

--------------------------------

### Download a starter kit with npm init adonisjs

Source: https://v6-docs.adonisjs.com/guides/getting-started/installation

Use the -K flag to specify a starter kit repository. The default is GitHub, but you can prefix with 'gitlab:' or 'bitbucket:' for other providers.

```shellscript
npm init adonisjs@latest -- -K="github_user/repo"

# Download from GitLab
npm init adonisjs@latest -- -K="gitlab:user/repo"

# Download from Bitbucket
npm init adonisjs@latest -- -K="bitbucket:user/repo"
```

--------------------------------

### sentenceCase usage

Source: https://v6-docs.adonisjs.com/guides/references/helpers

Converts a value to a sentence. Example: string.sentenceCase('getting_started-with-adonisjs') returns 'Getting started with adonisjs'.

```typescript
import string from '@adonisjs/core/helpers/string'

string.sentenceCase('getting_started-with-adonisjs')
// Getting started with adonisjs
```

--------------------------------

### Install @adonisjs/bouncer

Source: https://v6-docs.adonisjs.com/guides/security/authorization

Run this command to install and configure the @adonisjs/bouncer package. It sets up the service provider, command, abilities and policies files, and the middleware.

```shellscript
node ace add @adonisjs/bouncer
```

--------------------------------

### installPackages: Install packages using detected package manager

Source: https://v6-docs.adonisjs.com/guides/concepts/scaffolding

Installs one or multiple packages using the detected package manager. The example installs vinejs and edge as regular dependencies.

```typescript
const codemods = await command.createCodemods()

try {
  await codemods.installPackages([
    { name: 'vinejs', isDevDependency: false },
    { name: 'edge', isDevDependency: false }
  ])
} catch (error) {
  console.error('Unable to install packages')
  console.error(error)
}
```

--------------------------------

### Example structure of the types directory

Source: https://v6-docs.adonisjs.com/guides/getting-started/folder-structure

Shows the default empty `types` directory with example files `events.ts` and `container.ts`. Use this as a reference for where to place custom TypeScript interfaces and types.

```text
├── types
│  ├── events.ts
│  ├── container.ts
```

--------------------------------

### Download a private starter kit with git mode

Source: https://v6-docs.adonisjs.com/guides/getting-started/installation

Use the --mode=git flag to download private repositories using Git+SSH authentication.

```shellscript
npm init adonisjs@latest -- -K="user/repo" --mode=git
```

--------------------------------

### Basic HTTP test example

Source: https://v6-docs.adonisjs.com/guides/testing/http-tests

Example test that makes a GET request to /users and asserts the status and body. Uses the client object from the test context.

```typescript
import { test } from '@japa/runner'

test.group('Users list', () => {
  test('get a list of users', async ({ client }) => {
    const response = await client.get('/users')

    response.assertStatus(200)
    response.assertBody({
      data: [
        {
          id: 1,
          email: 'foo@bar.com',
        }
      ]
    })
  })
})
```

--------------------------------

### Create a slim starter kit project

Source: https://v6-docs.adonisjs.com/guides/getting-started/installation

Initializes a new AdonisJS project using the slim starter kit. Use the --db flag to switch the database dialect (e.g., mysql).

```shellscript
npm init adonisjs@latest -- -K=slim

# Switch database dialect
npm init adonisjs@latest -- -K=slim --db=mysql
```

--------------------------------

### Create a web starter kit project

Source: https://v6-docs.adonisjs.com/guides/getting-started/installation

Initializes a new AdonisJS project using the web starter kit. Use the --db flag to switch the database dialect (e.g., mysql).

```shellscript
npm init adonisjs@latest -- -K=web

# Switch database dialect
npm init adonisjs@latest -- -K=web --db=mysql
```

--------------------------------

### Get request method and intended method

Source: https://v6-docs.adonisjs.com/guides/basics/request

Use request.method() to get the HTTP method used for route matching (including spoofed methods) and request.intended() to get the original request method. This example is inside a PATCH route handler.

```typescript
import router from '@adonisjs/core/services/router'

router.patch('posts', async ({ request }) => {
  /**
   * The method that was used for route matching
   */
  console.log(request.method())

  /**
   * The actual request method
   */
  console.log(request.intended())
})
```

--------------------------------

### Get accepted content types with request.types

Source: https://v6-docs.adonisjs.com/guides/basics/request

Use request.types() to get an ordered list of content types from the Accept header, most preferred first. This example logs the list to the console.

```typescript
import router from '@adonisjs/core/services/router'

router.get('/', async ({ request }) => {
  console.log(request.types())
})
```

--------------------------------

### Import Drive service and get disk instances

Source: https://v6-docs.adonisjs.com/guides/digging-deeper/drive

Import the Drive service singleton and use the use() method to get the default disk or a named disk (e.g., 'r2' or 'spaces').

```typescript
import drive from '@adonisjs/drive/services/main'

drive instanceof DriveManager // true

/**
 * Returns instance of the default disk
 */
const disk = drive.use()

/**
 * Returns instance of a disk named r2
 */
const disk = drive.use('r2')

/**
 * Returns instance of a disk named spaces
 */
const disk = drive.use('spaces')
```

--------------------------------

### Create a resource controller with make:controller

Source: https://v6-docs.adonisjs.com/guides/basics/controllers

Run this Ace command to scaffold a controller with the standard resource methods (index, create, store, show, edit, update, destroy). The `--resource` flag adds these methods.

```shellscript
node ace make:controller posts --resource
```

--------------------------------

### Create an API starter kit project

Source: https://v6-docs.adonisjs.com/guides/getting-started/installation

Initializes a new AdonisJS project using the API starter kit. Use the --db flag to switch the database dialect (e.g., mysql).

```shellscript
npm init adonisjs@latest -- -K=api

# Switch database dialect
npm init adonisjs@latest -- -K=api --db=mysql
```

--------------------------------

### Dynamic exceptRoutes function for CSRF

Source: https://v6-docs.adonisjs.com/guides/security/securing-ssr-applications

Use a function for exceptRoutes to dynamically exempt routes. This example exempts all routes starting with /api/.

```typescript
{
  exceptRoutes: (ctx) => {
    // exempt all routes starting with /api/
    return ctx.request.url().includes('/api/')
  }
}
```

--------------------------------

### Create an API starter kit project with access tokens authentication

Source: https://v6-docs.adonisjs.com/guides/getting-started/installation

Initializes a new AdonisJS project using the API starter kit with token-based authentication via the --auth-guard flag.

```shellscript
npm init adonisjs@latest -- -K=api --auth-guard=access_tokens
```

--------------------------------

### boot method example

Source: https://v6-docs.adonisjs.com/guides/concepts/service-providers

The `boot` method is called after all bindings are registered. You can resolve bindings from the container to extend or mutate them.

```typescript
export default class AppProvider {
  async boot() {
   const validator = await this.app.container.make('validator')
    
   // Add custom validation rules
   validator.rule('foo', () => {})
  }
}
```

--------------------------------

### Read and write encrypted and plain cookies

Source: https://v6-docs.adonisjs.com/guides/testing/browser-tests

Example showing methods to set and get encrypted and plain cookies using `setEncryptedCookie`, `setPlainCookie`, `getEncryptedCookie`, and `getPlainCookie`.

```typescript
// Write
await browserContext.setEncryptedCookie('username', 'virk')
await browserContext.setPlainCookie('username', 'virk')

// Read
await browserContext.getEncryptedCookie('cartTotal')
await browserContext.getPlainCookie('cartTotal')
```

--------------------------------

### PM2 ecosystem.config.js for production server

Source: https://v6-docs.adonisjs.com/guides/getting-started/deployment

Example PM2 ecosystem file to run the AdonisJS app in cluster mode with autorestart. Use as a starting point for production deployment.

```javascript
module.exports = {
  apps: [
    {
      name: 'web-app',
      script: './server.js',
      instances: 'max',
      exec_mode: 'cluster',
      autorestart: true,
    },
  ],
}
```

--------------------------------

### Specify a branch, tag, or commit for a starter kit

Source: https://v6-docs.adonisjs.com/guides/getting-started/installation

Append a hash (#) to the repository reference to select a specific branch, tag, or commit.

```shellscript
# Branch
npm init adonisjs@latest -- -K="user/repo#develop"

# Tag
npm init adonisjs@latest -- -K="user/repo#v2.1.0"
```

--------------------------------

### app.startPath

Source: https://v6-docs.adonisjs.com/guides/concepts/application

Returns path to a file inside the start directory.

```APIDOC
## app.startPath

### Description
Returns path to a file inside the start directory.

### Method
startPath

### Signature
`app.startPath(path?: string): string`

### Parameters
- **path** (string) - Optional - The relative path to the file within the start directory.

### Returns
- **string** - The absolute path to the file or the start directory if no path is provided.

### Example
```typescript
app.startPath('routes.ts')
// /project_root/start/routes.ts

app.startPath()
// /project_root/start
```
```

--------------------------------

### getTsMorphProject: Get ts-morph project instance

Source: https://v6-docs.adonisjs.com/guides/concepts/scaffolding

Returns an instance of ts-morph for custom file transformations not covered by the Codemods API. The example shows retrieving a source file from the project.

```typescript
const project = await codemods.getTsMorphProject()

project.getSourceFileOrThrow('start/routes.ts')
```

--------------------------------

### Create a controller with ace make:controller

Source: https://v6-docs.adonisjs.com/guides/basics/controllers

Run this command to scaffold a new controller in the app/controllers directory.

```shellscript
node ace make:controller users
```

--------------------------------

### Create a new AdonisJS project with npm init

Source: https://v6-docs.adonisjs.com/guides/getting-started/installation

Run `npm init adonisjs@latest hello-world` to create a new project. This downloads the create-adonisjs initializer package.

```shellscript
npm init adonisjs@latest hello-world
```

--------------------------------

### Define a route with a name (posts.show)

Source: https://v6-docs.adonisjs.com/guides/basics/routing

Defines a GET route for 'posts/:id' and names it 'posts.show' using the 'as' method. This route is used in subsequent examples to generate URLs.

```typescript
import router from '@adonisjs/core/services/router'
const PostsController = () => import('#controllers/posts_controller')

router
  .get('posts/:id', [PostsController, 'show'])
  .as('posts.show')

```

--------------------------------

### Install @adonisjs/ally with optional provider flags

Source: https://v6-docs.adonisjs.com/guides/authentication/social-authentication

Run this command to install and configure the @adonisjs/ally package. Use the `--providers` flag to specify which OAuth providers to set up, e.g., `--providers=github --providers=google`.

```shellscript
node ace add @adonisjs/ally

# Define providers as CLI flags
node ace add @adonisjs/ally --providers=github --providers=google
```

--------------------------------

### Get sent and queued emails during tests

Source: https://v6-docs.adonisjs.com/guides/digging-deeper/mail

Use `mails.sent()` and `mails.queued()` to retrieve arrays of sent and queued emails. The example shows how to find a specific email by its notification class and assert its details.

```typescript
const { mails } = mail.fake()

const sentEmails = mails.sent()
const queuedEmails = mails.queued()

const email = sentEmails.find((email) => {
  return email instanceof VerifyEmailNotification
})

if (email) {
  email.message.assertTo(userData.email)
  email.message.assertFrom(userData.email)
  email.message.assertHtmlIncludes('<a href="/verify/email"> Verify your email address</a>')
}
```

--------------------------------

### Create an Inertia starter kit project

Source: https://v6-docs.adonisjs.com/guides/getting-started/installation

Initializes a new AdonisJS project using the Inertia starter kit. Use the --adapter flag to choose the frontend framework (react, vue, solid, svelte) and --ssr/--no-ssr to toggle server-side rendering.

```shellscript
npm init adonisjs@latest -- -K=inertia

# React with server-side rendering
npm init adonisjs@latest -- -K=inertia --adapter=react --ssr

# Vue without server-side rendering
npm init adonisjs@latest -- -K=inertia --adapter=vue --no-ssr
```

--------------------------------

### List available commands

Source: https://v6-docs.adonisjs.com/guides/ace/introduction

Shows all available commands by running the ace entry point without arguments or using the `list` command. Both are equivalent.

```shellscript
node ace

# Same as above
node ace list
```

--------------------------------

### Define lifecycle hooks in a service provider

Source: https://v6-docs.adonisjs.com/guides/concepts/application-lifecycle

Service providers define lifecycle hooks as methods in the provider class. This example shows the available methods: register, boot, start, ready, and shutdown.

```typescript
import { ApplicationService } from '@adonisjs/core/types'

export default class AppProvider {
  constructor(protected app: ApplicationService) {}
  
  register() {
  }
  
  async boot() {
  }
  
  async start() {
  }
  
  async ready() {
  }
  
  async shutdown() {
  }
}
```

--------------------------------

### Create a service provider with make:provider

Source: https://v6-docs.adonisjs.com/guides/references/commands

Creates a service provider file in the 'providers' directory. Uses singular form with 'provider' suffix.

```shellscript
node ace make:provider app
```

--------------------------------

### BaseCommand with staysAlive and explicit terminate

Source: https://v6-docs.adonisjs.com/guides/concepts/application-lifecycle

In the console environment, a command with `staysAlive: true` will not terminate automatically and must call `this.terminate()` explicitly. This example shows a command that starts the app, runs a process, and then terminates.

```typescript
import { BaseCommand } from '@adonisjs/core/ace'

export default class GreetCommand extends BaseCommand {
  static options = {
    startApp: true,
    staysAlive: true,
  }
  
  async run() {
    await runSomeProcess()
    
    // Terminate the process
    await this.terminate()
  }
}
```

--------------------------------

### SSR allowlist with dynamic function

Source: https://v6-docs.adonisjs.com/guides/views-and-templates/inertia

Configures SSR to dynamically decide which pages to render using a function. The function receives the context and page name, returning true to render the page. In this example, pages starting with 'admin' are excluded.

```typescript
import { defineConfig } from '@adonisjs/inertia'

export default defineConfig({
  ssr: {
    enabled: true,
    pages: (ctx, page) => !page.startsWith('admin')
  }
})
```

--------------------------------

### Access authenticated user with auth.user

Source: https://v6-docs.adonisjs.com/guides/authentication/basic-auth-guard

Use the auth.user property inside a route to get the logged-in user. Since the auth middleware is applied, auth.user is always available. The example uses the non-null assertion operator (!) to access the email.

```typescript
import { middleware } from '#start/kernel'
import router from '@adonisjs/core/services/router'

router
  .get('dashboard', ({ auth }) => {
    return `You are authenticated as ${auth.user!.email}`
  })
  .use(middleware.auth({
    guards: ['basicAuth']
  }))
```

--------------------------------

### Basic session usage: set and get theme

Source: https://v6-docs.adonisjs.com/guides/basics/session

Shows how to store a value in the session using session.put and read it with session.get. The session data is read at the start of the request and written back at the end, so changes are kept in memory until the request finishes.

```typescript
import router from '@adonisjs/core/services/router'

router.get('/theme/:color', async ({ params, session, response }) => {
  session.put('theme', params.color)
  response.redirect('/')
})

router.get('/', async ({ session }) => {
  const colorTheme = session.get('theme')
  return `You are using ${colorTheme} color theme`
})
```

--------------------------------

### Solid server entrypoint (inertia/app/ssr.tsx)

Source: https://v6-docs.adonisjs.com/guides/views-and-templates/inertia

Creates the server entrypoint for Solid SSR. Uses hydrate from solid-js/web and createInertiaApp from inertia-adapter-solid. Resolves page components from ./pages/**/*.tsx.

```tsx
import { hydrate } from 'solid-js/web'
import { createInertiaApp } from 'inertia-adapter-solid'

export default function render(page: any) {
  return createInertiaApp({
    page,
    resolve: (name) => {
      const pages = import.meta.glob('./pages/**/*.tsx', { eager: true })
      return pages[`./pages/${name}.tsx`]
    },
    setup({ el, App, props }) {
      hydrate(() => <App {...props} />, el)
    },
  })
}
```

--------------------------------

### Create a test file with make:test

Source: https://v6-docs.adonisjs.com/guides/references/commands

Creates a new test file inside the tests/<suite> directory. The example creates a test file for the 'unit' suite.

```shellscript
node ace make:test --suite=unit
```

--------------------------------

### Dockerfile for AdonisJS production deployment

Source: https://v6-docs.adonisjs.com/guides/getting-started/deployment

Use this Dockerfile to create a Docker image for your AdonisJS application. It uses a multi-stage build: installs all dependencies, then production-only dependencies, builds the app, and finally runs the production server. The image exposes port 8080 and starts with `node ./bin/server.js`. Modify it as needed.

```docker
FROM node:22.16.0-alpine3.22 AS base

# All deps stage
FROM base AS deps
WORKDIR /app
ADD package.json package-lock.json ./
RUN npm ci

# Production only deps stage
FROM base AS production-deps
WORKDIR /app
ADD package.json package-lock.json ./
RUN npm ci --omit=dev

# Build stage
FROM base AS build
WORKDIR /app
COPY --from=deps /app/node_modules /app/node_modules
ADD . .
RUN node ace build

# Production stage
FROM base
ENV NODE_ENV=production
WORKDIR /app
COPY --from=production-deps /app/node_modules /app/node_modules
COPY --from=build /app/build /app
EXPOSE 8080
CMD ["node", "./bin/server.js"]
```

--------------------------------

### Install @adonisjs/redis package

Source: https://v6-docs.adonisjs.com/guides/database/redis

Run this command to install and configure the @adonisjs/redis package. It installs the package, registers the provider, creates config/redis.ts, and defines environment variables.

```shellscript
node ace add @adonisjs/redis
```

--------------------------------

### List REPL helper methods

Source: https://v6-docs.adonisjs.com/guides/digging-deeper/repl

Use the .ls command to view available helper methods in the REPL. The output shows the global methods and their descriptions.

```shellscript
> (js) .ls

# GLOBAL METHODS:
importDefault         Returns the default export for a module
make                  Make class instance using "container.make" method
loadApp               Load "app" service in the REPL context
loadEncryption        Load "encryption" service in the REPL context
loadHash              Load "hash" service in the REPL context
loadRouter            Load "router" service in the REPL context
loadConfig            Load "config" service in the REPL context
loadTestUtils         Load "testUtils" service in the REPL context
loadHelpers           Load "helpers" module in the REPL context
clear                 Clear a property from the REPL context
p                     Promisify a function. Similar to Node.js "util.promisify"
```

--------------------------------

### Install @adonisjs/cors package

Source: https://v6-docs.adonisjs.com/guides/security/cors

Run this command to install and configure the @adonisjs/cors package. It installs the package, registers the service provider, creates the config file, and registers the middleware.

```shellscript
node ace add @adonisjs/cors
```

--------------------------------

### Clone the repository

Source: https://v6-docs.adonisjs.com/guides/preface/contribution-guide

Start by cloning the repo on your local machine. Replace <REPO_URL> with the actual repository URL.

```shellscript
git clone <REPO_URL>
```

--------------------------------

### Install Transmit package with ace add command

Source: https://v6-docs.adonisjs.com/guides/digging-deeper/transmit

Run this command to install and configure the @adonisjs/transmit package. It installs the package, registers the provider in adonisrc.ts, and creates config/transmit.ts.

```shellscript
node ace add @adonisjs/transmit
```

--------------------------------

### Create preload file with make:preload ace command

Source: https://v6-docs.adonisjs.com/guides/digging-deeper/emitter

Run this command to create the start/events.ts file where event listeners are defined.

```shellscript
node ace make:preload events
```

--------------------------------

### Install @japa/openapi-assertions

Source: https://v6-docs.adonisjs.com/guides/testing/http-tests

Install the OpenAPI assertions plugin as a dev dependency.

```shellscript
npm i -D @japa/openapi-assertions
```

--------------------------------

### Example structure of the providers directory

Source: https://v6-docs.adonisjs.com/guides/getting-started/folder-structure

Shows the `providers` directory containing `app_provider.ts` and `http_server_provider.ts`. New providers can be created using the `node ace make:provider` command.

```text
├── providers
│  └── app_provider.ts
│  └── http_server_provider.ts
```

--------------------------------

### Run migrations to create auth_access_tokens table

Source: https://v6-docs.adonisjs.com/guides/authentication/access-tokens-guard

Executes the migration:run command to create the auth_access_tokens table. This is part of the initial setup.

```shellscript
node ace migration:run
```

--------------------------------

### Create unit test for greet command

Source: https://v6-docs.adonisjs.com/guides/testing/console-tests

Run this Ace command to generate a unit test file for the greet command. The output shows the created file path.

```shellscript
node ace make:test commands/greet --suite=unit

# DONE:    create tests/unit/commands/greet.spec.ts
```

--------------------------------

### Install Inertia package

Source: https://v6-docs.adonisjs.com/guides/views-and-templates/inertia

Command to install the @adonisjs/inertia package via npm.

```shellscript
npm i @adonisjs/inertia
```

--------------------------------

### Use ally.use() to switch between providers

Source: https://v6-docs.adonisjs.com/guides/authentication/social-authentication

Shows how to retrieve driver instances for configured providers using ally.use(). Also demonstrates dynamic provider selection via route parameters with a regex constraint.

```typescript
router.get('/github/redirect', ({ ally }) => {
  // GitHub driver instance
  const gh = ally.use('github')
})

router.get('/twitter/redirect', ({ ally }) => {
  // Twitter driver instance
  const twitter = ally.use('twitter')
})

// You could also dynamically retrieve the driver
router.get('/:provider/redirect', ({ ally, params }) => {
  const driverInstance = ally.use(params.provider)
}).where('provider', /github|twitter/)
```

--------------------------------

### Install jsonwebtoken package

Source: https://v6-docs.adonisjs.com/guides/authentication/custom-auth-guard

Installs the jsonwebtoken package and its TypeScript types via npm.

```shellscript
npm i jsonwebtoken @types/jsonwebtoken
```

--------------------------------

### List registered routes with list:routes

Source: https://v6-docs.adonisjs.com/guides/references/commands

Boots the application in the console environment and displays all registered routes. Supports options like --json, --table, --middleware, and --ignore-middleware.

```shellscript
node ace list:routes
```

--------------------------------

### Service provider lifecycle methods

Source: https://v6-docs.adonisjs.com/guides/concepts/service-providers

These are the lifecycle methods you can implement in a service provider: register, boot, start, ready, and shutdown.

```typescript
export default class AppProvider {
  register() {
  }
  
  async boot() {
  }
  
  async start() {
  }
  
  async ready() {
  }
  
  async shutdown() {
  }
}
```
Tokens:
Raw