PootisPenserHere/payroll_manager
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

[fix] Indenting

Browse Source
This commit is contained in:
Jose Pablo Domingo Aramburo Sanchez 2018-08-16 14:11:31 -06:00 committed by GitHub
parent dcac46b1fb
commit 956c22f73c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 61 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
documentation/README.rst
View File

@ -1,75 +1,75 @@
============= ================
Documentation Documentation
============= ================
.. contents:: .. contents::
Functional requirements Requirements
-------------------------- ----------------------------------
Funtional:
- A user name and password auth - A user name and password auth
- Encrypted sensitive data - Encrypted sensitive data
- The employee need to have their full name captured - The employee need to have their full name captured
- The last name must tolerate being null - The last name must tolerate being null
- An email will be needed for the employee - An email will be needed for the employee
- The email format must be formated - The email format must be formated
- Employees will need a phone number - Employees will need a phone number
- Searching employees despite the encryption - Searching employees despite the encryption
- Employees must have a unique code to reference them - Employees must have a unique code to reference them
- Being able to modify the name, email and phone values of already existing employees - Being able to modify the name, email and phone values of already existing employees
- Having the values for the different payments parametrized - Having the values for the different payments parametrized
- Allowing for employees to perform other roles during their work day - Allowing for employees to perform other roles during their work day
- Only for the auxiliary personnel - Only for the auxiliary personnel
- Taking into account only the current month for the salary - Taking into account only the current month for the salary
- Reducing the taxes for the salary - Reducing the taxes for the salary
- If it goes beyond the threshold a different percentage is paid in taxes - If it goes beyond the threshold a different percentage is paid in taxes
- The way the extra tax is handled should be parametrized - The way the extra tax is handled should be parametrized
Non functional requirements
---------------------------
- Session management
- Data integrity
- Data security
- Accessible through web
- Containerized
In Funtional:
----- - Session management
- Employee details - Data integrity
- Data security
- Accessible through web
- Containerized
Software behaivor
-----------------
In:
- Employee details
- First name - First name
- Middle name - Middle name
- Last name - Last name
- Birth date - Birth date
- Email - Email
- Phone number - Phone number
- Work per day - Work per day
- Number of deliveries - Number of deliveries
- Rol performed - Rol performed
Process:
- Register a new employee
- Modify employee
- Search employee
- Add new work day for employee
- Calculate monthly payment for employee
Process Out:
----------- - Upon registering
- Register a new employee
- Modify employee
- Search employee
- Add new work day for employee
- Calculate monthly payment for employee
Out
-----
- Upon registering
- Employee code - Employee code
- In the work days registry - In the work days registry
- Raw salary for the the month - Raw salary for the the month
- Taxes discounted - Taxes discounted
- Real salary for the month - Real salary for the month
- Vouchers (if applicable) - Vouchers (if applicable)
Tests Tests
------- -----------------
here go the tests Tests:
- here go the tests
Tools and software used Tools
------ ----------------------------------
The following tools and software were used:
- phpstorm - phpstorm
- git - git
- docker && docker-compose - docker && docker-compose