{"id":20505687,"url":"https://github.com/adonisjs-community/create-adonis-ts-app","last_synced_at":"2025-05-09T07:31:36.651Z","repository":{"id":40269048,"uuid":"196822829","full_name":"adonisjs-community/create-adonis-ts-app","owner":"adonisjs-community","description":"Boilerplate to create a new AdonisJs typescript project","archived":false,"fork":false,"pushed_at":"2024-01-16T12:36:53.000Z","size":3137,"stargazers_count":101,"open_issues_count":2,"forks_count":18,"subscribers_count":7,"default_branch":"develop","last_synced_at":"2024-11-11T21:37:00.353Z","etag":null,"topics":["adonisjs","create-app","hacktoberfest"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adonisjs-community.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-14T10:26:31.000Z","updated_at":"2024-09-20T16:45:02.000Z","dependencies_parsed_at":"2024-01-08T05:21:33.058Z","dependency_job_id":"f665a99f-afb7-4695-9702-c77661586ec6","html_url":"https://github.com/adonisjs-community/create-adonis-ts-app","commit_stats":null,"previous_names":["adoniscommunity/adonis-ts-boilerplate"],"tags_count":59,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adonisjs-community%2Fcreate-adonis-ts-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adonisjs-community%2Fcreate-adonis-ts-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adonisjs-community%2Fcreate-adonis-ts-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adonisjs-community%2Fcreate-adonis-ts-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adonisjs-community","download_url":"https://codeload.github.com/adonisjs-community/create-adonis-ts-app/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224838436,"owners_count":17378265,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adonisjs","create-app","hacktoberfest"],"created_at":"2024-11-15T19:49:13.636Z","updated_at":"2024-11-15T19:49:14.669Z","avatar_url":"https://github.com/adonisjs-community.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://res.cloudinary.com/adonisjs/image/upload/q_100/v1558612869/adonis-readme_zscycu.jpg\" width=\"600px\"\u003e\n\u003c/div\u003e\n\n\u003cbr /\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url] [![synk-image]][synk-url]\n\n\u003c/div\u003e\n\n\u003cbr /\u003e\n\n\n# Create AdonisJS App\n\u003e AdonisJS Typescript starter template\n\nThis is the official starter template to create AdonisJS applications. You can choose between one of the following boilerplates\n\n- **api**: Project structure + dependencies tailored for creating a REST API server.\n- **web**: Traditional web application with server rendered templates and pre-configured support for sessions.\n- **slim**: A smallest possible AdonisJS application. Still way powerful and feature rich than an Express application.\n\n## Creating a new app\n\n```sh\nnpm init adonis-ts-app hello-world\n```\n\nYarn users\n\n```sh\nyarn create adonis-ts-app hello-world\n```\n\n![](assets/create-adonis-ts-app.gif)\n\n## Options\n\nExecute the following command to see the help output and available options\n\n```sh\nnpm init adonis-ts-app\n```\n\n```\n    _       _             _         _     \n   / \\   __| | ___  _ __ (_)___    | |___ \n  / _ \\ / _` |/ _ \\| '_ \\| / __|_  | / __|\n / ___ \\ (_| | (_) | | | | \\__ \\ |_| \\__ \\\n/_/   \\_\\__,_|\\___/|_| |_|_|___/\\___/|___/\n\nnpm init adonis-ts-app \u003cproject-name\u003e\n\nOptions\n--boilerplate [api, web, slim]    Select the project boilerplate\n--name \u003cstring\u003e                   Specify application name\n--eslint \u003cboolean\u003e                Enable/disable eslint setup\n--prettier \u003cboolean\u003e              Enable/disable prettier setup\n--encore \u003cboolean\u003e                Enable/disable encore setup\n--debug \u003cboolean\u003e                 Turn on the debug mode\n```\n\n#### boilerplate\n\nChoose the boilerplate by passing the flag\n\n```sh\nnpm init adonis-ts-app hello-world -- --boilerplate=web\n```\n\n#### name\n\nDefine the application name. The `name` property inside the `package.json` file will reflect this value\n\n```sh\nnpm init adonis-ts-app hello-world -- --name=my-app\n```\n\n#### eslint\n\nConfigure eslint\n\n```sh\nnpm init adonis-ts-app hello-world -- --eslint\n```\n\n#### prettier\n\nConfigure prettier\n\n```sh\nnpm init adonis-ts-app hello-world -- --prettier\n```\n\n#### encore\n\nConfigure encore\n\n```sh\nnpm init adonis-ts-app hello-world -- --encore\n```\n\n#### debug\n\nDebug the project creation process. This flag will use the verbose output for better debugging experience.\n\n```sh\nnpm init adonis-ts-app hello-world -- --debug\n```\n\n\u003cdiv align=\"center\"\u003e\n  \u003csub\u003eBuilt with ❤︎ by \u003ca href=\"https://github.com/thetutlage\"\u003eHarminder Virk\u003c/a\u003e\n\u003c/div\u003e\n\n[npm-image]: https://img.shields.io/npm/v/create-adonis-ts-app/latest.svg?style=for-the-badge\u0026logo=npm\n[npm-url]: https://www.npmjs.com/package/create-adonis-ts-app/v/alpha \"npm\"\n\n[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge\u0026logo=typescript\n\n[license-url]: LICENSE.md\n[license-image]: https://img.shields.io/github/license/adonisjs-community/create-adonis-ts-app?style=for-the-badge\n\n[synk-image]: https://img.shields.io/snyk/vulnerabilities/github/adonisjs-community/create-adonis-ts-app?label=Synk%20Vulnerabilities\u0026style=for-the-badge\n[synk-url]: https://snyk.io/test/github/adonisjs-community/create-adonis-ts-app?targetFile=package.json \"synk\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadonisjs-community%2Fcreate-adonis-ts-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadonisjs-community%2Fcreate-adonis-ts-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadonisjs-community%2Fcreate-adonis-ts-app/lists"}