Giter Club home page Giter Club logo

req-qa's Introduction

REQ-QA: Automatic identification of possible deficiencies in the introduction of requirements

Introduction

This project was created as a part of the end degree project Automatic identification of possible deficiencies in the introduction of requirements
in collaboration with Facultat d'Informàtica de Barcelona.

The service analyze the requirements in natural language and return a deficiencies found.

The service has the aim to allow the extensibility as one of the pillars in order to add more functionality.

Used OpenReq component:


Technical description

REQ-QA is based on Java Spring Boot and use Maven.

How to extend with external service

Create a maven module and implements IRequirementExternalService interface extending to RequirementExternalService.

The core engine will call all the services that implements the interface and aggregates the results.

Previous requisites

Build the project

mvn clean install -DSkipTest

Create a Docker image

docker build -t reqqa .

Run the docker image

docker run -p 8089:8089 -e "JAVA_OPTS=-Dopenreq.baseUrl=http://host.docker.internal:9799" reqqa

How to use

There are a core API to use (/analyze), see swagger documentation

There is a form web page to use as well.

Taiga integration

In order to operate with Taiga, there are a previous configuration that has to be done:

Run the docker image with Taiga integration

When run the docker image, send the configured parameters as:

  • taiga.baseUrl: the url of Taiga server
  • taiga.secret: secret key configured in Taiga for the webhook
  • taiga.customFieldName: custom field name, by default "quality"
  • taiga.username: username in Taiga used to modify the issues
  • taiga.password: password for the user in Taiga
docker run -p 8089:8089 -e "JAVA_OPTS=-Dopenreq.baseUrl=http://host.docker.internal:9799 -Dtaiga.baseUrl=http://host.docker.internal:9000 -Dtaiga.customFieldName=mycustomfield -Dtaiga.username=username -Dtaiga.password=password" reqqa

req-qa's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.