Inspiration

I got my inspiration for this project from when I worked at a small software development startup. There was a lot of back-and-forth due to unclear, vague requirements. Since it was a co-located team, a lot of misinterpretation of requirements happened. This led to rework and so much development time wasted. I built this tool to identify and suggest fixes to requirements before any development work begins. This will reduce the time and costs of software development.

What it does

ReQCheck identifies words and phrases that are considered ambiguous, like quickly. It then suggests a better version of the requirement, which assists the person managing the backlog items(Business Analysts, Product Owners, Developers, etc.) to write clear, unambiguous requirements.

How we built it

I built ReqCheck with Laravel for the backend, ReactJS for the front end, and an AI engine built with Python to run the analyzer. I used GitLab Duo AI to assist with CI/CD. It was awesome

Challenges we ran into

The first challenge was that I was new to GitLab Duo AI. However, its learning curve is pretty smooth. I enjoyed it. The other challenge was linking my SSH from my hosting provider with GitLab; the credentials part(whitespace issues) disturbed me a lot. Thankfully, GitLab Duo showed me a workaround

Accomplishments that we're proud of

Building the custom flow that is able to detect ambiguous words within issues in the repository I am proud of myself for actually pushing to the end of this hackathon. And not allowing perfectionism to hold me back anymore

What we learned

I learned that CI CD does not have to be so manual and tedious. GitLab Duo AI actually automates everything beautifully

What's next for ReQCheck

Deploy a live application where actual users can begin using the tool

Built With

Share this project:

Updates

Submission history