A service for exposing specification files in version control via a nice web UI
MIT License
A service for exposing specifications expressed as Gherkin feature files via a nice web UI.
In the UI specify a https URL for a Git repo, and if that repo contains markdown or feature files they will be displayed. The idea is to make specifications stored in a repo visible and searchable, for people who aren't familiar with version control systems, and as part of a living documentation system.
If you want to run Specs as a service we recommend you use the Docker instructions given below.
We're trying out continuous delivery on this project so in theory the master
branch is always stable. A demo is available at http://specs.sponte.uk/ , it may take a few seconds to spin up and will not persist data for long.
npm install
.npm start
-- by default the web UI will be visible at http://localhost:3000/.npm install --global gulp
. If you would like to see a list of available tasks just type gulp
. There are some other tasks defined in the package.json which are currently used for CI purposes.To install the latest version from npm
npm install -g oss-specs
.oss-specs
.docker run -Pd specs/specs
to run the container in the background and map ports from the container to the containing VM.Alternatively, get the container image here https://hub.docker.com/r/specs/specs/ and start it in whatever way you prefer.
There are two types of possible configuration:
The file should be in the root of your repository. The file an be named specs.json
or .specs.json
. See the .specs.json file in the root of this repository for examples.
Keys:
There is a POST request route defined on the deployed app root URL for requesting repos to be checked out or updated, for instance if the app is deployed to myspecs.example.com then the POST route for adding or updating the Specs repo would be https://myspecs.example.com/?repo_url=https%3A%2F%2Fgithub.com%2Foss-specs%2Fspecs.git
.
This can be useful for instance in configuring web-hooks in your Git server so that the information in your Specs deployment is updated whenever someone pushes new information your remote Git repo.
(C) 2015