Development docs!
This commit is contained in:
@@ -12,6 +12,4 @@
|
||||
- [Plugin API](customization/plugin-api.md)
|
||||
|
||||
### Development
|
||||
- [Architecture overview](development/architecture.md)
|
||||
- [Setting up a dev environment](development/setting-up.md)
|
||||
- [Test suite](development/test-suite.md)
|
||||
|
||||
24
docs/development/setting-up.md
Normal file
24
docs/development/setting-up.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# Setting up a dev environment
|
||||
|
||||
Swagger-UI includes a development server that provides hot module reloading and unminified stack traces, for easier development.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Node.js `6.0.0` or greater
|
||||
- npm `3.0.0` or greater
|
||||
- git, any version
|
||||
|
||||
|
||||
### Steps
|
||||
|
||||
1. `git clone git@github.com:swagger-api/swagger-ui.git`
|
||||
2. `cd swagger-ui`
|
||||
3. `npm install`
|
||||
4. `npm run dev`
|
||||
5. Wait a bit
|
||||
6. Open http://localhost:3200/
|
||||
|
||||
## Bonus round
|
||||
|
||||
- Swagger-UI includes an ESLint rule definition. If you use a graphical editor, consider installing an ESLint plugin, which will point out syntax and style errors for you as you code.
|
||||
- The linter runs as part of the PR test sequence, so don't think you can get away with not paying attention to it!
|
||||
@@ -35,8 +35,6 @@ app.use(express.static(pathToSwaggerUi))
|
||||
app.listen(3000)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Docker Hub
|
||||
|
||||
You can pull a pre-built docker image of the swagger-ui directly from Dockerhub:
|
||||
|
||||
Reference in New Issue
Block a user