{"id":15690601,"url":"https://github.com/nartc/tsoa-hackathon-ready","last_synced_at":"2025-07-01T18:06:21.874Z","repository":{"id":66345477,"uuid":"121294595","full_name":"nartc/TSOA-Hackathon-Ready","owner":"nartc","description":"A Hackathon Starter Pack using TSOA for Node Express MongoDB Backend Rapid Development","archived":false,"fork":false,"pushed_at":"2018-03-06T20:47:13.000Z","size":147,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-07T23:45:32.981Z","etag":null,"topics":["expressjs","hackathon","mongodb","mongoose","nodejs","swagger","tsoa","typescript"],"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/nartc.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}},"created_at":"2018-02-12T19:56:16.000Z","updated_at":"2022-06-21T15:07:03.000Z","dependencies_parsed_at":"2023-02-21T23:46:15.443Z","dependency_job_id":null,"html_url":"https://github.com/nartc/TSOA-Hackathon-Ready","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nartc/TSOA-Hackathon-Ready","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nartc%2FTSOA-Hackathon-Ready","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nartc%2FTSOA-Hackathon-Ready/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nartc%2FTSOA-Hackathon-Ready/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nartc%2FTSOA-Hackathon-Ready/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nartc","download_url":"https://codeload.github.com/nartc/TSOA-Hackathon-Ready/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nartc%2FTSOA-Hackathon-Ready/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263013712,"owners_count":23399813,"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":["expressjs","hackathon","mongodb","mongoose","nodejs","swagger","tsoa","typescript"],"created_at":"2024-10-03T18:12:37.286Z","updated_at":"2025-07-01T18:06:21.851Z","avatar_url":"https://github.com/nartc.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TSOA Hackathon Ready Pack\n\nThe project is a starter-pack which utilizes **lukeautry/tsoa** package ([TSOA Official Github](https://github.com/lukeautry/tsoa)) for **Node** **Express** and **MongoDB** backend rapid development in **TypeScript** which enables the **Repository Pattern**design. \n\n**TSOA** provides a **CLI Tool** to **generate** *Routes* and *Swagger Specs* to empower **SwaggerUI** for APIs Documentation. \n\n# Steps\n1. Clone the repo\n2. **IMPORTANT**: Install *devDependencies* first by running `npm install --only=dev`. This is to install **copyfiles** and **typescript** packages. The reason is that I am using my *forked* repo of the *official lukeautry/tsoa* repo.\n3. Install *dependencies*\n4. Run `npm run start-gen` to generate `routes.ts` and `swagger.json`\n5. Run `npm start` to start the server. Alternatively, you can run `npm run start-dev` to run `tsc -w` and `nodemon` to keep watching for file changes but there is a *bug* when using **concurrently**.\n6. Server will run locally on port **8080**. **SwaggerUI** will run at: `localhost:8080/api/docs`\n\n# Author\n- Nartc (Chau): Just a developer.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnartc%2Ftsoa-hackathon-ready","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnartc%2Ftsoa-hackathon-ready","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnartc%2Ftsoa-hackathon-ready/lists"}