Automatic Documents Administration (formerly WAP), a tool to manage sprints and generate Project Log Documents
What is ADA ?
Installation
Frontend
Contributing
ADA is a tool originally developed by two EPITECH students to easily manage the creations of PLDs, and manage the cards assigned to each user on a sprint.
The main idea behind ADA is to make more conscistent PLDs, with less errors, in less time.
To handle automatically the creation of the PLDs and ensure a faster and more accurate PLD, ADA is designed to integrate the user-stories in a sort of workflown and be robust about what can and can't be done.
The main problems ADA solves are the following:
- The PLD take too much time to make, one day everytime a new one must be done -- ADA shorten this time to 2 minutes.
- The PLD have many typos in it, many mistakes and errors -- ADA let you review every user-stories written by anyone before accepting them in the PLD.
- Peoples don't have informations on the progress of others peoples cards -- ADA let you view the progress of everyone in your team as well as what should be done.
- "I need to change the description of the card after having made the first PLD, can we do this without telling anyone ?" -- Yes you can do this. But this will be written.
- "PLD must be generated at 8:00" -- PLD WILL be generated at 8:00.
- "I didn't update my work on ADA" -- Then this will not appear on the PLD.
Think of ADA as way to ensure the PLD is qualitative while making it in no time
- When a card is submited by an user, the card goes for verification by admins and editors, if the card contains mistakes, the editors and admins can edit the card, then accept it. If the card is unnnaceptable, the card can be rejected.
- One a card is in the system, every edit made by admins and editors on the card will (smartly) increment the internal version of the card and display a message on the generated PLD accordingly.
- An user can't edit a card that has been accepted by an admin or an editor.
The generated PLD is fully programatically customizable, but you can use the generator we used in our team at src/defaultPldGenerator.ts
To install ADA you'll need to have Docker and a MySQL database with a database ready for ADA.
Run ADA on Docker by redirecting the port 4000 and setting thoses environment variables:
docker run -d \
-p 80:4000 \
-e PROD_DB_HOST="localhost" \
-e PROD_DB_NAME="ADA" \
-e PROD_DB_PORT="3306" \
-e PROD_DB_USER="root" \
-e PROD_DB_PASS="root" \
-e NODE_ENV="production" \
-e PORT="4000" \
theohmmr/ada:dev
The frontend application of ADA is primarly maintened by @protoxvga on the ADA frontend repository
ADA is open to contributions, feel free to open an issue, fork the repository, and create a PR