https://github.com/nullbeam/example-node-ts
Example - Node JS application with Typescript and OpenAPI
https://github.com/nullbeam/example-node-ts
express nodejs openapi typescript
Last synced: about 1 month ago
JSON representation
Example - Node JS application with Typescript and OpenAPI
- Host: GitHub
- URL: https://github.com/nullbeam/example-node-ts
- Owner: nullbeam
- License: mit
- Created: 2023-08-06T22:57:41.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-30T21:10:31.000Z (over 2 years ago)
- Last Synced: 2024-04-17T00:04:12.550Z (almost 2 years ago)
- Topics: express, nodejs, openapi, typescript
- Language: JavaScript
- Homepage:
- Size: 70.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Example Node JS with TypeScript and OpenAPI
This project is an example, you can use for learning or as project template
## How to start
This project needs Node JS > 14.21.2, you can install it from https://nodejs.org/ and going to run the following commands:
1. Install dependencies
```bash
npm install
```
2. Run project as developer
```bash
npm run dev
```
3. Transform it to javascript to production environment
```bash
npm run build
```
Run the project and access the documentation at:
http://localhost:3000/swagger
### Aditional commands:
- For generate swagger docs without start project as developer
```bash
npm run swagger-autogen
```