From fa8422c8b0fec9eb16e61e69686d7e4f1d3b8067 Mon Sep 17 00:00:00 2001 From: Jose Pablo Domingo Aramburo Sanchez Date: Thu, 16 Aug 2018 12:49:15 -0600 Subject: [PATCH] [add] README --- documentation/README.rst | 53 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 documentation/README.rst diff --git a/documentation/README.rst b/documentation/README.rst new file mode 100644 index 0000000..ec6bc05 --- /dev/null +++ b/documentation/README.rst @@ -0,0 +1,53 @@ +================ +Documentation +================ + +.. contents:: + +Functional requirements +-------------------------- + +- A user name and password auth +- Encrypted sensitive data +- The employee need to have their full name captured + - The last name must tolerate being null +- An email will be needed for the employee + - The email format must be formated +- Employees will need a phone number +- Searching employees despite the encryption +- Employees must have a unique code to reference them +- Being able to modify the name, email and phone values of already existing employees +- Having the values for the different payments parametrized +- Allowing for employees to perform other roles during their work day + - Only for the auxiliars +- Taking into account only the current momth for the salary +- Reducing the taxes for the salary + - If it goes beyond the threshold a differnt percentaje is paid in taxes + - The way the extra tax is handled should be parametrized + + Non functional requirments + --------------------------- + - Session management +- Data integrity +- Data security +- Accessible through web +- Containerized + +In +----- + +Procesos +----------- + +Out +----- + +Tests +------- + +Tools and software used +------ +- phpstorm +- git +- docker && docker-compose +- Ubuntu 16