CD2H gitForager

Scout24/api

Name: api

Owner: AutoScout24

Description: The AutoScout24 API documentation

Forked from: lord/slate

Created: 2016-02-03 13:17:37.0

Updated: 2017-10-09 21:36:46.0

Pushed: 2018-02-07 17:00:33.0

Homepage:

Size: 2763

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

AutoScout24 API Documentation

This project uses middleman and middleman-gh-pages to create the API documentation.

Development

Run bundle exec middleman server to run the application on dev mode.
Go to http://localhost:4567 to see the documentation
Changes will trigger a “build” and static files will be automatically generated

Additional ways of serving content

Run bundle exec middleman build to create the static files
cd to the build folder
Open the index.html file or serve the entire build folder with one of the following options:
- python -m SimpleHTTPServer # within the build folder
- docker run --rm -v $(pwd):/usr/share/nginx/html:ro nginx
- run bundle exec middleman build every time you do a change
Changes will be automatically available without restart

Deploy

Run ./deploy.sh
Be happy

AutoScout24 API Documentation

This project uses middleman and middleman-gh-pages to create the API documentation.

Development

Run bundle exec middleman server to run the application on dev mode.
Go to http://localhost:4567 to see the documentation
Changes will trigger a “build” and static files will be automatically generated

Additional ways of serving content

Run bundle exec middleman build to create the static files
cd to the build folder
Open the index.html file or serve the entire build folder with one of the following options:
- python -m SimpleHTTPServer # within the build folder
- docker run --rm -v $(pwd):/usr/share/nginx/html:ro nginx
- run bundle exec middleman build every time you do a change
Changes will be automatically available without restart

Deploy

Run ./deploy.sh
Be happy

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.