Skip to content

opsidao/api_blueprint_server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This is a very simple node application that will easily allow you to publish a Github repository populated with API blueprints to a Heroku Dyno.

Notice that I basically have no idea about node so you wouldn't be too precautious if you checked the code before using this... you've been warned ;)

Configuration

All the configuration is made using environment variables, and all the settings are required:

  • BASIC_AUTH_USER: Username for the HTTP basic authentication required to acces the app.
  • BASIC_AUTH_PASSWORD: Password for the HTTP basic authentication required to access the app.
  • PORT: Port to listen to on run (This is set for you on heroku).
  • GITHUB_TOKEN: The Oauth token to access github. You can create one for this application here. You should give this token the repo and/or the public_repo scopes, depending on wether your source repository is private or not.
  • REPO_USER: The user part of your repository (i.e. your username or organization name).
  • REPO_NAME: The name of the repository.

Wishlist (In no particular order)

  • Support for folders
  • Integrate a testing framework and start testing stuff (Vows.js looks interesting, maybe with the should package).
  • Allow to serve a local folder, to use it during development.
  • Login with Github, requiring access to the served repository to access the site.
  • Branch support so you can preview your pull requests before merging them.
  • Related to that, allow registering for github callbacks to post a link to pull requests in the served github repository so we can put a link to that branch's html representation as a comment in the pull request.
  • Custom theme support, to allow branding of the site.
  • Proper layout.
  • Improved logging.
  • Support for validations with connection to the Github Status API

About

A very, very simple Api Blueprint to HTML web server in Node

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published