Skip to content
This repository was archived by the owner on Sep 14, 2022. It is now read-only.

Commit c60c32c

Browse files
authored
Add documentation about running in deployment
Added a description to clarify whether you should use `node app.js` or `swagger project start` in a deployment.
1 parent 172e1c7 commit c60c32c

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/quick-start.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,9 @@ Now that we've got our basic API running, let's open the Swagger editor.
6565
*The Swagger editor*
6666
![alt text](./images/swagger-editor.png)
6767
68+
### <a name='production'></a>Running Swagger Node in a Deployment
69+
70+
When you run a swagger-node based application in a proper deployment, you should use `node <entrypoint>` (typically, `node app.js`) as opposed to using the swagger cli tooling.
6871
6972
### <a name='windows'></a>Windows users
7073
For some versions of npm on Windows will have problems on the `npm install` step of `swagger project create`. They are related to a `debug` module on npm not being managed properly. The following steps should resolve this issue:

0 commit comments

Comments
 (0)