{"id":23282786,"url":"https://github.com/itsallcode/openfasttrace","last_synced_at":"2025-04-04T06:09:41.752Z","repository":{"id":37502354,"uuid":"48654534","full_name":"itsallcode/openfasttrace","owner":"itsallcode","description":"Open source requirement tracing suite","archived":false,"fork":false,"pushed_at":"2025-03-20T08:49:10.000Z","size":3905,"stargazers_count":107,"open_issues_count":37,"forks_count":22,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-03-28T05:13:32.651Z","etag":null,"topics":["java","markdown","openfasttrace","quality-assurance","requirements-management","requirements-tracing","software-engineering"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/itsallcode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","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":"2015-12-27T17:50:25.000Z","updated_at":"2025-03-23T19:18:04.000Z","dependencies_parsed_at":"2023-12-16T08:23:37.891Z","dependency_job_id":"d26b9460-a787-4e27-a5c5-ded6c19c74b8","html_url":"https://github.com/itsallcode/openfasttrace","commit_stats":{"total_commits":967,"total_committers":25,"mean_commits":38.68,"dds":"0.49741468459152016","last_synced_commit":"8999a712221049c8fee77b3d1f7f447e5a0ef4dc"},"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsallcode%2Fopenfasttrace","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsallcode%2Fopenfasttrace/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsallcode%2Fopenfasttrace/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsallcode%2Fopenfasttrace/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itsallcode","download_url":"https://codeload.github.com/itsallcode/openfasttrace/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247128753,"owners_count":20888235,"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":["java","markdown","openfasttrace","quality-assurance","requirements-management","requirements-tracing","software-engineering"],"created_at":"2024-12-20T00:29:49.110Z","updated_at":"2025-04-04T06:09:41.734Z","avatar_url":"https://github.com/itsallcode.png","language":"Java","readme":"# \u003cimg src=\"core/src/main/resources/openfasttrace_logo.svg\" alt=\"OFT logo\" width=\"150\"/\u003e OpenFastTrace\n\n## What is OpenFastTrace?\n\nOpenFastTrace (short OFT) is a requirement tracing suite. Requirement tracing keeps track of whether you actually implemented everything you planned to in your specifications. It also identifies obsolete parts of your product and helps you to get rid of them.\n\nYou can learn more about requirement tracing and how to use OpenFastTrace in the [user guide](doc/user_guide.md).\n\nBelow you see a screenshot of an HTML tracing report where OFT traces itself. You see a summary followed by a detail view of the traced requirements. \n\n\u003cimg src=\"doc/images/oft_screenshot_tracing_report.png\" style=\"box-shadow: 5px 10px 18px #888888;\" alt=\"OFT HTML tracing report\"\u003e\n\n## Project Information\n\n[![Build](https://github.com/itsallcode/openfasttrace/actions/workflows/build.yml/badge.svg)](https://github.com/itsallcode/openfasttrace/actions/workflows/build.yml)\n[![Maven Central](https://img.shields.io/maven-central/v/org.itsallcode.openfasttrace/openfasttrace.svg?label=Maven%20Central)](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.itsallcode.openfasttrace%22%20a%3A%22openfasttrace%22)\n\nSonarcloud status:\n\n[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode.openfasttrace%3Aopenfasttrace-root\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-root)\n[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode.openfasttrace%3Aopenfasttrace-root\u0026metric=bugs)](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-root)\n[![Code smells](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode.openfasttrace%3Aopenfasttrace-root\u0026metric=code_smells)](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-root)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode.openfasttrace%3Aopenfasttrace-root\u0026metric=coverage)](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-root)\n[![Duplicated Lines](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode.openfasttrace%3Aopenfasttrace-root\u0026metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-root)\n[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode.openfasttrace%3Aopenfasttrace-root\u0026metric=ncloc)](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-root)\n[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode.openfasttrace%3Aopenfasttrace-root\u0026metric=sqale_rating)](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-root)\n[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode.openfasttrace%3Aopenfasttrace-root\u0026metric=reliability_rating)](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-root)\n[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode.openfasttrace%3Aopenfasttrace-root\u0026metric=security_rating)](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-root)\n[![Technical Dept](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode.openfasttrace%3Aopenfasttrace-root\u0026metric=sqale_index)](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-root)\n[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode.openfasttrace%3Aopenfasttrace-root\u0026metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=org.itsallcode.openfasttrace%3Aopenfasttrace-root)\n\n**User Guides**\n\n* [📖 User Guide](doc/user_guide.md)\n* [🔌 Extending OpenFastTrace With Plugins](doc/plugins.md)\n* [💲 Command Line Usage](core/src/main/resources/usage.txt)\n\n**News and Discussions**\n\n* [📢 Blog](https://blog.itsallcode.org/)\n* [➕ Changelog](doc/changes/changes.md)\n* [📅 Upcoming Milestones](https://github.com/orgs/itsallcode/projects/3/views/3)\n* [🗨️ Discussion Board](https://github.com/itsallcode/openfasttrace/discussions)\n* [✨ OpenFastTrace Stories](https://github.com/itsallcode/openfasttrace/wiki/OFT-Stories)\n* [ℹ️ About us](doc/about_us.md)\n\n**Information for Contributors**\n\n* [🎟️ Project Board](https://github.com/orgs/itsallcode/projects/3/views/1)\n* [🦮 Developer Guide](doc/developer_guide.md)\n* [🔌 Plugin Developer Guide](doc/plugin_developer_guide.md)\n* [🎁 Contributing Guide](CONTRIBUTING.md)\n* [💡 System Requirements](doc/spec/system_requirements.md)\n* [👜 Design](doc/spec/design.md)\n\n**Demos and Presentations**\n\n* [📹 Introduction Video](https://www.youtube.com/watch?v=tlzMT6RaVWA) (YouTube, 3:30 minutes)\n* [🛗 Elevator pitch](https://github.com/itsallcode/openfasttrace-demo/tree/main?tab=readme-ov-file#elevator-pitch)\n* [📽️ OpenFastTrace Presentation](https://github.com/itsallcode/openfasttrace-demo/blob/main/OpenFastTrace_in_20_minutes.odp) (LibreOffice, 20 minutes)\n* [🎬 OpenFastTrace Live Demo Script](https://github.com/itsallcode/openfasttrace-demo/blob/main/oft-live-demo-medium.md) (Markdown, 1 hour)\n\n## Using OpenFastTrace\n\nIf you want to use OFT, you have the choice between using it as part of your build process \u0026mdash; typically with Maven or Gradle. Or you can run OFT from the command line.\n\nCheck the [user guide](doc/user_guide.md) for detailed information on how to use OpenFastTrack.\n\n## Getting OpenFastTrace\n\nOpenFastTrace at it's core is a Java Archive (short \"[JAR](https://docs.oracle.com/javase/8/docs/technotes/guides/jar/jar.html#JAR%20Manifest)\"). This file contains the OpenFastTrace Library and an entry point for [running OFT from the command line](#running-openfasttrace).\n\n### Getting Pre-Built Packages\n\nPre-Built JAR files (called `openfasttrace-4.1.0.jar`) are available from the following places:\n\n* [Maven Central](https://repo1.maven.org/maven2/org/itsallcode/openfasttrace/openfasttrace/4.1.0/openfasttrace-4.1.0.jar)\n* [GitHub](https://github.com/itsallcode/openfasttrace/releases/download/4.1.0/openfasttrace-4.1.0.jar)\n \nCheck our [developer guide](doc/developer_guide.md#getting-the-openfasttrace-library) to learn how to use the OFT JAR as dependency in your own code with popular build tools.\n\n## Installation\n\n### Runtime Dependencies\n\nOpenFastTrace 4.0.0 and above only needs a Java 17 (or later) runtime environment to run. OpenFastTrace until version 3.x.x supported Java 11. Versions prior to that ran with Java 8.\nNote that only the latest version of OFT is actively supported.\n\n#### Installation of Runtime Dependencies on Linux\n\n##### Ubuntu or Debian\n\nIf you just want to run OFT:\n\n    apt-get install openjdk-17-jre\n\n## Running OpenFastTrace\n\nThe most basic variant to run OpenFastTrace is directly from the JAR file via the command line:\n\n```bash\njava -jar product/target/openfasttrace-4.1.0.jar trace /path/to/directory/being/traced\n```\n\nIf you want to run OFT automatically as part of a continuous build, we recommend using our plugins for [Gradle](https://github.com/itsallcode/openfasttrace-gradle) and [Maven](https://github.com/itsallcode/openfasttrace-maven-plugin).\n\nFor more details about how to run OFT please consult the [user guide](doc/user_guide.md).\n\n## Development\n\nIf you want to learn how to build OpenFastTrace, please check our [Developer Guide](doc/developer_guide.md).\n\nYou would like to contribute to OFT? Please check out our [Contributor Guide](CONTRIBUTING.md) to get started. \n","funding_links":[],"categories":["项目管理"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitsallcode%2Fopenfasttrace","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitsallcode%2Fopenfasttrace","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitsallcode%2Fopenfasttrace/lists"}