Skip to content

Commit 18a53b6

Browse files
author
Bec Martin
committed
Initial commit from create-openapi-repo
0 parents  commit 18a53b6

14 files changed

+3845
-0
lines changed

Diff for: .gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Dir for API portal deploy
2+
web_deploy
3+
node_modules

Diff for: LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2016 Ivan Goncharov
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

Diff for: README.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# MessageMedia OpenAPI Specification
2+
3+
4+
## Working on specification
5+
### Install
6+
7+
1. Install [Node JS](https://nodejs.org/)
8+
2. Clone repo and run `npm install` in the repo root
9+
10+
### Usage
11+
12+
#### `npm start`
13+
Starts the development server.
14+
15+
#### `npm run build`
16+
Bundles the spec and prepares web_deploy folder with static assets.
17+
18+
#### `npm test`
19+
Validates the spec.
20+
21+
#### `npm run gh-pages`
22+
Deploys docs to GitHub Pages. You don't need to run it manually if you have Travis CI configured.

0 commit comments

Comments
 (0)