https://github.com/alvinnn-r/learnadonis
Learn Adonis Framework Node.js
https://github.com/alvinnn-r/learnadonis
Last synced: 10 months ago
JSON representation
Learn Adonis Framework Node.js
- Host: GitHub
- URL: https://github.com/alvinnn-r/learnadonis
- Owner: Alvinnn-R
- Created: 2023-01-23T09:21:48.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-23T15:00:28.000Z (almost 3 years ago)
- Last Synced: 2025-04-12T20:58:55.771Z (10 months ago)
- Language: TypeScript
- Homepage:
- Size: 176 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url] [![synk-image]][synk-url]
# Create AdonisJS App
> AdonisJS Typescript starter template
This is the official starter template to create AdonisJS applications. You can choose between one of the following boilerplates
- **api**: Project structure + dependencies tailored for creating a REST API server.
- **web**: Traditional web application with server rendered templates and pre-configured support for sessions.
- **slim**: A smallest possible AdonisJS application. Still way powerful and feature rich than an Express application.
## Creating a new app
```sh
npm init adonis-ts-app hello-world
```
Yarn users
```sh
yarn create adonis-ts-app hello-world
```
## Options
Execute the following command to see the help output and available options
```sh
npm init adonis-ts-app
```
```
_ _ _ _
/ \ __| | ___ _ __ (_)___ | |___
/ _ \ / _` |/ _ \| '_ \| / __|_ | / __|
/ ___ \ (_| | (_) | | | | \__ \ |_| \__ \
/_/ \_\__,_|\___/|_| |_|_|___/\___/|___/
npm init adonis-ts-app
Options
--boilerplate [api, web, slim] Select the project boilerplate
--name Specify application name
--eslint Enable/disable eslint setup
--prettier Enable/disable prettier setup
--encore Enable/disable encore setup
--debug Turn on the debug mode
```
#### boilerplate
Choose the boilerplate by passing the flag
```sh
npm init adonis-ts-app hello-world -- --boilerplate=web
```
#### name
Define the application name. The `name` property inside the `package.json` file will reflect this value
```sh
npm init adonis-ts-app hello-world -- --name=my-app
```
#### eslint
Configure eslint
```sh
npm init adonis-ts-app hello-world -- --eslint
```
#### prettier
Configure prettier
```sh
npm init adonis-ts-app hello-world -- --prettier
```
#### encore
Configure encore
```sh
npm init adonis-ts-app hello-world -- --encore
```
#### debug
Debug the project creation process. This flag will use the verbose output for better debugging experience.
```sh
npm init adonis-ts-app hello-world -- --debug
```
[npm-image]: https://img.shields.io/npm/v/create-adonis-ts-app/latest.svg?style=for-the-badge&logo=npm
[npm-url]: https://www.npmjs.com/package/create-adonis-ts-app/v/alpha "npm"
[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
[license-url]: LICENSE.md
[license-image]: https://img.shields.io/github/license/adonisjs-community/create-adonis-ts-app?style=for-the-badge
[synk-image]: https://img.shields.io/snyk/vulnerabilities/github/adonisjs-community/create-adonis-ts-app?label=Synk%20Vulnerabilities&style=for-the-badge
[synk-url]: https://snyk.io/test/github/adonisjs-community/create-adonis-ts-app?targetFile=package.json "synk"