{"id":15097760,"url":"https://github.com/kauefraga/node-typescript-server","last_synced_at":"2026-01-06T16:56:29.028Z","repository":{"id":197110814,"uuid":"697988392","full_name":"kauefraga/node-typescript-server","owner":"kauefraga","description":"🧰 An awesome kickstart server with all the features you would expect, for Node + Typescript + Koa development.","archived":false,"fork":false,"pushed_at":"2023-10-02T23:03:21.000Z","size":104,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-21T14:09:20.901Z","etag":null,"topics":["api","boilerplate","koajs","nodejs","server","template"],"latest_commit_sha":null,"homepage":"","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/kauefraga.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-09-28T22:33:51.000Z","updated_at":"2023-10-17T02:34:19.000Z","dependencies_parsed_at":"2023-10-03T04:34:23.546Z","dependency_job_id":null,"html_url":"https://github.com/kauefraga/node-typescript-server","commit_stats":null,"previous_names":["kauefraga/node-typescript-server"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kauefraga%2Fnode-typescript-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kauefraga%2Fnode-typescript-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kauefraga%2Fnode-typescript-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kauefraga%2Fnode-typescript-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kauefraga","download_url":"https://codeload.github.com/kauefraga/node-typescript-server/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245853872,"owners_count":20683263,"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":["api","boilerplate","koajs","nodejs","server","template"],"created_at":"2024-09-25T16:40:27.718Z","updated_at":"2026-01-06T16:56:28.987Z","avatar_url":"https://github.com/kauefraga.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Node Typescript Server\n\n![GitHub top language](https://img.shields.io/github/languages/top/kauefraga/node-typescript-server)\n![NPM downloads](https://img.shields.io/npm/dm/create-node-typescript-server)\n![GitHub's license](https://img.shields.io/github/license/kauefraga/node-typescript-server)\n![GitHub last commit (branch)](https://img.shields.io/github/last-commit/kauefraga/node-typescript-server/main)\n\n\u003c!-- tag: downloads/execuções do cnts (create-node-typescript-server) --\u003e\n\n\u003e 🧰 An awesome kickstart server with all the features you would expect, for Node + Typescript + Koa development.\n\n### Features\n\n- [x] Simplicity and flexibility.\n- [x] Typescript out-of-box.\n  - [x] Use [`tsx`](https://github.com/esbuild-kit/tsx) to develop with a blazingly fast hot-reloading.\n  - [x] Use [`tsup`](https://github.com/egoist/tsup) to bundle code with no configuration.\n- [x] Path aliases to clean up noisy paths, see [more explanation](docs/path-aliases.md).\n- [x] Tiny and robust web framework, [Koa](https://koajs.com).\n  - [x] Equipped with [Koa Router](https://www.npmjs.com/package/koa-router).\n\n## ⬇ How to install it\n\n```bash\npnpx create-node-typescript-server # or npx create-node-typescript-server\n```\n\nOr\n\n1. Clone the repository\n2. Copy the environment variables\n3. Install the dependencies\n4. Change some stuff\n\n```bash\n# (1)\ngit clone https://github.com/kauefraga/node-typescript-server.git {your-project-name}\ncd {your-project-name}\n\n# (2)\ncp .env.example .env\n\n# (3)\npnpm install --frozen-lockfile # or npm ci\n\n# (4)\n# You should rewrite the README for your project\n# You should change the \"name\" in the package.json\n# You probably will need to remove the example files\n```\n\n## 🗺 Getting started\n\n### Typescript Settings\n\nLook at [the tsconfig.json](tsconfig.json).\n\nI highly recommend you to read those resources:\n\n- [tsconfig cheat sheet](https://www.totaltypescript.com/tsconfig-cheat-sheet)\n- [strictest tsconfig/base](https://github.com/tsconfig/bases/blob/031273b815ff7f672c7c9057fb7d19ef363054b1/bases/strictest.json)\n\n### Environment Variables\n\nLook at [the .env.example](.env.example).\n\n- `PORT`: the HTTP server port number (default: 3333).\n\n\u003e [!NOTE]\n\u003e Currently, i am using Node 18.17.1, therefore i choose `dotenv` package to load environment variables because it's the most stable solution. If you are reading it in the future (20.8.x LTS or above), consider removing `dotenv` and using [`node --env-file=.env`](https://nodejs.org/api/cli.html#--env-fileconfig).\n\n### Unit Tests\n\nRun tests:\n\n```bash\npnpm test # or npm run test\n```\n\nLook at [the vitest config](vitest.config.ts).\nPowered by [Vitest](https://vitest.dev).\n\n## 🏗 Architecture and codebase\n\nIt's a monolithic application and you should keep it like that for this boilerplate.\n\nBelow you can see an explanation of the codebase:\n\n- `src` - It's where our code lives.\n  - `core` - Specifications and business rules will be here.\n  - `http` - The HTTP thing (server, API, ...) will go here.\n  - `infra` - Infrastructure stuff, such as database, migrations, cache...\n- `core/domain`\n  - `entities/models/schemas` - Definitions of our entities (User, Book, Post, Pet, etc...).\n  - `repositories` - Interfaces and implementations of repositories.\n  - `usecases` - Use cases of our application.\n\nWhere is the test folder?? You will see the tests right next of their definition/implementation.\n\nLook at [the source code](src).\n\n## ⭐ Recommendations\n\nThe following list has some suggestions, remember that you don't need to follow them strictly, as the codebase specifications.\n\n- I suggest you to write git commit messages following [Gitmoji](https://github.com/carloscuesta/gitmoji) and/or [Conventional Commits](https://www.conventionalcommits.org).\n- Also, configure a linter to make your codebase more consistent. Here's [a guide for eslint setup](docs/eslint.md).\n- Type `npx create-node-typescript-server` on your terminal and hit enter 🧞‍♂️\n\n\u003c!-- fazer/procurar um middleware simples de limite de requisições\n\npensar sobre banco de dados, logger...\n\ndescrever a estrutura de pastas (core, http e infra -\u003e controllers, middlewares, entities/models, repositories, usecases, migrations...) --\u003e\n\n## 📝 License\n\nThis project is licensed under the MIT License - See the [LICENSE](https://github.com/kauefraga/node-typescript-server/blob/main/LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkauefraga%2Fnode-typescript-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkauefraga%2Fnode-typescript-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkauefraga%2Fnode-typescript-server/lists"}