Merge pull request #133 from Filirom1/master

Simplify build
This commit is contained in:
Tony Tam
2013-01-23 09:44:18 -08:00
2 changed files with 31 additions and 8 deletions

View File

@@ -18,10 +18,9 @@ unpack and start using it. If you like swagger-ui as-is, stop here.
### Build
You can rebuild swagger-ui on your own to tweak it or just so you can say you did. To do so, follow these steps:
1. Install [CoffeeScript](http://coffeescript.org/#installation) which will give you [cake](http://coffeescript.org/#cake)
2. Install [handlebars](http://handlebarsjs.com/) using 'npm install handlebars -g'
3. Run cake dist
4. You should see the distribution under the dist folder. Open ./dist/index.html to launch Swagger UI in a browser
1. npm install
2. npm run-script build
3. You should see the distribution under the dist folder. Open ./dist/index.html to launch Swagger UI in a browser
### Use
Once you open the Swagger UI, it will load the [Swagger Petstore](http://petstore.swagger.wordnik.com/api/resources.json) service and show its APIs.

24
package.json Normal file
View File

@@ -0,0 +1,24 @@
{
"name": "swagger-ui",
"version": "0.1.7",
"description": "Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API",
"scripts": {
"build": "PATH=$PATH:./node_modules/.bin cake dist",
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "https://github.com/wordnik/swagger-ui.git"
},
"author": {
"name": "Tony Tam",
"email": "fehguy@gmail.com",
"url": "http://developer.wordnik.com"
},
"license": "Apache",
"readmeFilename": "README.md",
"dependencies": {
"coffee-script": "~1.4.0",
"handlebars": "~1.0.8"
}
}