Smart City - Citizen Engagement - Doc Skeleton

Documentation of the API of the Citizen Engagement

This is a generator that compiles Markdown and RAML files into a static site. The following Node.js stack is used:

• Build tasks using Grunt
• Content assembling with Metalsmith
• Templating using Jade
• CSS-preprocessing with Stylus
• Basic styling using Twitter Bootstrap

Note that apart from Markdown support within the RAML spec it also supports plain .md files that are compiled independently from the API documentation.

Quickstart

Prerequisites

• Make sure Node.js is installed and in your PATH
• Install Grunt: npm install -g grunt-cli

Installation

1. Clone the repo.
2. cd the folder.
3. Install dependencies: npm install
4. Run the dev server: grunt dev --private=true
5. Open a browser at http://localhost:7000/

Deployment on Heroku

Basically, you have nothing special to do. Follow the instruction of Heroku to setup your computer ready to use their service. Then, you have just to push your code on Heroku after created the application on Heroku. That's it. The doc application is already configured to be deployed easily.

Credits

To APIDoc Seed.

License