{"id":14969359,"url":"https://github.com/augurk/augurk","last_synced_at":"2025-10-23T18:15:40.824Z","repository":{"id":17013498,"uuid":"19776912","full_name":"Augurk/Augurk","owner":"Augurk","description":"living documentation on your own terms","archived":false,"fork":false,"pushed_at":"2024-03-27T11:05:20.000Z","size":6291,"stargazers_count":42,"open_issues_count":27,"forks_count":14,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-06-24T15:16:09.833Z","etag":null,"topics":["cucumber","gherkin","specflow","specification-by-example"],"latest_commit_sha":null,"homepage":"https://augurk.github.io","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Augurk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"License.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-05-14T11:30:20.000Z","updated_at":"2024-10-28T12:58:03.000Z","dependencies_parsed_at":"2024-09-27T11:40:58.388Z","dependency_job_id":"1a9587d7-2269-411a-933b-705ce4262663","html_url":"https://github.com/Augurk/Augurk","commit_stats":{"total_commits":522,"total_committers":16,"mean_commits":32.625,"dds":0.3754789272030651,"last_synced_commit":"fe1d27f3cb7de9e5be142c42c9b5435c9a894538"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"purl":"pkg:github/Augurk/Augurk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Augurk%2FAugurk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Augurk%2FAugurk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Augurk%2FAugurk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Augurk%2FAugurk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Augurk","download_url":"https://codeload.github.com/Augurk/Augurk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Augurk%2FAugurk/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262145233,"owners_count":23265896,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cucumber","gherkin","specflow","specification-by-example"],"created_at":"2024-09-24T13:41:44.725Z","updated_at":"2025-10-23T18:15:40.767Z","avatar_url":"https://github.com/Augurk.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"Augurk\n======\n\nAugurk is an always improving, open source, living documentation system designed to get maximum value out of [Gherkin](https://github.com/cucumber/cucumber/wiki/Gherkin)-based specifications. By continuously listening to the struggles and desires of various agile teams, Augurk aims to be the most natural fit for anyone wishing to publish their living documentation.\n\nAugurk provides an accessible, easy-to-use overview of all the features describing your application(s) on a webportal you can host within your own organization.\n\n## Inspiration ##\nAugurk is greatly influenced by [Relish](https://www.relishapp.com/)\nand [Pickles](http://www.picklesdoc.com/). While Relish is a great SaaS application,\nit requires you to publish your documentation to the cloud. While this is not an issue when your sources live in the cloud as well,\nin other cases it is often still preferable to keep the documentation within the corporate intranet.  \nThis leaves Pickles. Although Pickles adresses the cloud issue (it was designed for that purpose), it has\nsome short-comings of its own. Pickles generates a neat (Dynamic)HTML website for each project/solution you\nrequire it to. It does, however, not incorporate these. This means not only will you get a website for each solution,\nyou can multiply your number of websites with the number of branches you maintain simultaneously.\n\nAugurk has been designed to address exactly these issues. It allows you to publish your\nfeatures from multiple solutions and branches to a single location, providing you with a single access-point\nfor all your documentation. While Augurk is based upon the same principles as Pickles, it has \nbeen rebuild completely from the ground-up, allowing Augurk to provide all the same functionality but simultenously\nimproving and extending it where necessary.\n\n### Augurk? ###\nThe *Gherkin* language is used to write *Cucumber* specifications. \nSeeing as a *Gherkin* is a pickled cucumber, the naming of *Pickles*\nand *Relish* (a pickled food item) make perfect sense. Since that doesn't leave much\n*Gherkin* related terms in the English language, it was an almost natural choice to switch\nto a different language. Since *Augurk* is being developed in The Netherlands, \n*Augurk* (meaning pickle[d cucumber]) was a perfect fit.\n\n## How to set up your development environment ##\nGreat, you want to open our jar of augurk's!  \nLet's us help you set up the development environment, there are 3 steps to get you up and running.\n1. First you'll need *Visual Studio 2015* or newer to open the solution\n1. On the `Augurk` project, change the *IIS Express* bitness to x64  \n![Screenshot showing Augurk project settings screen to set the IIS bitness setting to x64](img/screenshot-setting-iis-bitness.png)\n1. Change the bitness of the *Test Runner* to x64  \n![Screenshot showing the Visual Studio menu option to set the test runner bitness setting to x64](img/screenshot-setting-testrunner-bitness.png)\n\nNow you should be able to run and test all code.\n\nJust as a note, the feature files that are part of the `Augurk.Specification` project are not implemented. Therefore, when you run all tests in the solution they will be skipped.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faugurk%2Faugurk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faugurk%2Faugurk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faugurk%2Faugurk/lists"}