https://github.com/nartc/tsoa-hackathon-ready
A Hackathon Starter Pack using TSOA for Node Express MongoDB Backend Rapid Development
https://github.com/nartc/tsoa-hackathon-ready
expressjs hackathon mongodb mongoose nodejs swagger tsoa typescript
Last synced: 12 months ago
JSON representation
A Hackathon Starter Pack using TSOA for Node Express MongoDB Backend Rapid Development
- Host: GitHub
- URL: https://github.com/nartc/tsoa-hackathon-ready
- Owner: nartc
- Created: 2018-02-12T19:56:16.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-06T20:47:13.000Z (over 8 years ago)
- Last Synced: 2025-05-07T23:45:32.981Z (about 1 year ago)
- Topics: expressjs, hackathon, mongodb, mongoose, nodejs, swagger, tsoa, typescript
- Language: TypeScript
- Size: 144 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TSOA Hackathon Ready Pack
The 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.
**TSOA** provides a **CLI Tool** to **generate** *Routes* and *Swagger Specs* to empower **SwaggerUI** for APIs Documentation.
# Steps
1. Clone the repo
2. **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.
3. Install *dependencies*
4. Run `npm run start-gen` to generate `routes.ts` and `swagger.json`
5. 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**.
6. Server will run locally on port **8080**. **SwaggerUI** will run at: `localhost:8080/api/docs`
# Author
- Nartc (Chau): Just a developer.