Create Adonis Ts App

screenshot of Create Adonis Ts App

Create Adonis Ts App

Boilerplate to create a new AdonisJs typescript project

Overview

The AdonisJS App is the official starter template for creating AdonisJS applications. It provides different boilerplates for different types of applications, including REST API servers and traditional web applications with server-rendered templates. It also offers a slim boilerplate for creating minimal but feature-rich AdonisJS applications.

Features

  • Multiple Boilerplates: Choose from different boilerplates depending on the type of application you want to create, such as REST API servers, web applications, or slim applications.
  • Customizable Application Name: Define the name of your application, which will be reflected in the package.json file.
  • Eslint Configuration: Configure eslint for your project.
  • Prettier Configuration: Configure prettier for your project.
  • Encore Configuration: Configure Encore for your project.
  • Debug Mode: Enable debug mode to get a verbose output for better debugging experience during the project creation process.

Installation

To install the AdonisJS App starter template, follow these steps:

  1. If you are a Yarn user, execute the following command to see the help output and available options:

    yarn create adonis-ts-app --help
    
  2. Choose the boilerplate by passing the --boilerplate flag followed by the name of the desired boilerplate. For example, to create a REST API server, use the following command:

    npx create-adonis-app@latest projectName --boilerplate=api
    
  3. Define the application name by passing the --name flag followed by the desired name. For example:

    npx create-adonis-app@latest projectName --boilerplate=api --name=MyApp
    
  4. Customize the project further by configuring eslint, prettier, and encore using the respective flags --eslint, --prettier, and --encore.

  5. Optionally, enable debug mode by passing the --debug flag.

Summary

The AdonisJS App starter template offers a convenient way to create AdonisJS applications. With its multiple boilerplate options, customizable application name, and configurable eslint, prettier, and encore settings, it provides flexibility and ease of use for developers. Additionally, the debug mode enhances the debugging experience during the project creation process.

eslint
Eslint

ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.

typescript
Typescript

TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.