Skip to content

Latest commit

 

History

History
90 lines (65 loc) · 3.79 KB

README.md

File metadata and controls

90 lines (65 loc) · 3.79 KB


Icely Annotator
Icely Annotator

An Annotation Tool for annotating software requirements and generate static ontology.

Docker Image Version (latest semver) GitHub last commit GitHub GitHub Repo stars

AboutKey FeaturesHow To UseRoadmapContributingLicense

screenshot

About

Icely Annotator is a tool for annotating software requirements and generate static ontology of Icely Framework.

This tool is based mainly on the brat annotation tool and S-Case Requirements Annotation tool.

✨ Key Features

  • Annotate Textual Requirement
  • Export Annotation to Static Ontology (.owl)
  • Visualize Textual Requirement
  • Auto-Annotate (In Progress)

🚀 How To Use

Using Docker (Recommended)

If you'd rather run the Icely Annotator from a Docker image, it is available on Docker Hub at icely/icely-annotator.

Building from source

To clone and run this application, you'll need Git and Python 3 (which comes with pip) installed on your computer. From your command line:

# Clone this repository
$ git clone [email protected]:IcelyFramework/icely-annotator.git

# Go into the repository
$ cd icely-annotator

# Install dependencies
$ pip install -r requirements.txt

# Create Directory and Copy Static Ontoloty
$ mkdir -p /app/icely-annotator/original_ontology/ && cp original_ontology/requirements.owl /app/icely-annotator/original_ontology/requirements.owl
# Run the app
$ python standalone.py

Note: for run server via Apache, brat documentation

☑ Roadmap

If you want to see a new feature feel free to create a new Issue. Here are some features which are either underway or planned:

If you'd like to give any of these a shot feel free to contribute.

Support

Buy Me A Coffee

License

Copyright © 2021 Amir Deljouyi.
Icely Annotator is made available under the MIT licensed.

🤝 Contributing

Contributions, issues and feature requests are welcome.
Feel free to check issues page if you want to contribute.


amirdeljouyi  ·  GitHub @amirdeljouyi  ·  Twitter @amirdeljouyi