lukeautry / tsoa

Build OpenAPI-compliant REST APIs using TypeScript and Node
MIT License
3.48k stars 498 forks source link

Add a minimal boilerplate repo to the docs. #1639

Closed joel1st closed 2 months ago

joel1st commented 3 months ago

Sorting

Detailed Description

I think we could benefit from a basic starter repo to help people quickly start a new project and try TSOA. Currently the docs are missing some config (eg. tsconfig.json settings) and there is a bit of debugging required to get up and running.

I'm aware that we have https://github.com/lukeautry/ts-app - but I think this is a little too involved for a starter repo.

As an example I've put together https://github.com/joel1st/tsoa-boilerplate which closely follows the guides from the docs and fills in the gaps where appropriate.

github-actions[bot] commented 3 months ago

Hello there joel1st 👋

Thank you for opening your very first issue in this project.

We will try to get back to you as soon as we can.👀

WoH commented 3 months ago

https://github.com/tsoa-community/starter is what the docs use for getting started

joel1st commented 3 months ago

Oh nice, I tried looking for this in the docs without any luck (and based off the repo activity I assume this is the case for others as well).

Have you got a link to where it is referenced in the docs?

Sent from my Galaxy

-------- Original message -------- From: Wolfgang Hobmaier @.> Date: 11/6/24 1:35 am (GMT+10:00) To: lukeautry/tsoa @.> Cc: joel1st @.>, Author @.> Subject: Re: [lukeautry/tsoa] Add a minimal boilerplate repo to the docs. (Issue #1639)

https://github.com/tsoa-community/starter is what the docs use for getting started

— Reply to this email directly, view it on GitHubhttps://github.com/lukeautry/tsoa/issues/1639#issuecomment-2158677241, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AA6YNJGZB3NMZEB7ZQYXW6TZGXBVHAVCNFSM6AAAAABJCROPWKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNJYGY3TOMRUGE. You are receiving this because you authored the thread.Message ID: @.***>

github-actions[bot] commented 2 months ago

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days