{"id":19528896,"url":"https://github.com/adonisjs/api-starter-kit","last_synced_at":"2025-10-11T05:32:46.774Z","repository":{"id":218027358,"uuid":"630437405","full_name":"adonisjs/api-starter-kit","owner":"adonisjs","description":"Starter kit for creating JSON API server using AdonisJS","archived":false,"fork":false,"pushed_at":"2025-07-29T15:25:05.000Z","size":330,"stargazers_count":10,"open_issues_count":1,"forks_count":12,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-10-11T05:32:04.903Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adonisjs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"thetutlage"}},"created_at":"2023-04-20T11:32:23.000Z","updated_at":"2025-07-29T15:25:10.000Z","dependencies_parsed_at":"2024-01-29T14:53:46.290Z","dependency_job_id":"2ae8641c-273f-4ec6-908e-48b3d42cf5e5","html_url":"https://github.com/adonisjs/api-starter-kit","commit_stats":null,"previous_names":["adonisjs/api-starter-kit"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/adonisjs/api-starter-kit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adonisjs%2Fapi-starter-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adonisjs%2Fapi-starter-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adonisjs%2Fapi-starter-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adonisjs%2Fapi-starter-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adonisjs","download_url":"https://codeload.github.com/adonisjs/api-starter-kit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adonisjs%2Fapi-starter-kit/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279006320,"owners_count":26084085,"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","status":"online","status_checked_at":"2025-10-11T02:00:06.511Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-11T01:20:38.348Z","updated_at":"2025-10-11T05:32:46.756Z","avatar_url":"https://github.com/adonisjs.png","language":"TypeScript","funding_links":["https://github.com/sponsors/thetutlage"],"categories":[],"sub_categories":[],"readme":"# AdonisJS API Starter Kit\n\nThis repo contains an AdonisJS application tailored for building an API server that responds with JSON.\n\n## What's included\n\n- TypeScript setup with commands to run developments server using `ts-node + swc` and create production build.\n- ESLint and Prettier setup extending the [AdonisJS tooling config](https://github.com/adonisjs/tooling-config) presets.\n- Ace command line framework.\n- Everything else you get with the core of AdonisJS.\n\nOn top of the framework core and dev-tooling, the following features are enabled by the API starter kit.\n\n- Lucid ORM ( Installed, but not configured )\n- Auth module ( Installed, but not configured )\n- CORS\n- VineJS for validations\n\n## Usage\n\nYou can create a new app using the `api` boilerplate by executing the following command. The command will perform the following steps.\n\n- Clone the repo\n- Install dependencies\n- Copy `.env.example` to `.env`\n- Set app key using `node ace generate:key` command.\n- Configure `@adonisjs/lucid` package.\n- Install and configure `@adonisjs/session` package (if using auth session guard).\n- Configure `@adonisjs/auth` package.\n\n```sh\nnpm init adonisjs -- -K=api\n```\n\n### Configuring Lucid database dialect\n\nBy default, the `npm init adonisjs` command configures Lucid to use `sqlite`. However, you can define a custom database dialect as follows.\n\n```sh\nnpm init adonisjs -- -K=api --db=postgres\n```\n\nAvailable options for the `--db` flag.\n\n- sqlite\n- postgres\n- mysql\n- mssql\n\n### Configuring Auth package guard\n\nBy default, the `npm init adonisjs` command configures the Auth package to use `session` guard. However, you can define a custom auth guard as follows.\n\n```sh\nnpm init adonisjs -- -K=api --auth-guard=access_tokens\n```\n\nAvailable options for the `--auth-guard` flag.\n\n- session\n- basic_auth\n- access_tokens\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadonisjs%2Fapi-starter-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadonisjs%2Fapi-starter-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadonisjs%2Fapi-starter-kit/lists"}