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

[add] Format and extra data

Browse Source
This commit is contained in:
Jose Pablo Domingo Aramburo Sanchez 2018-08-16 03:43:45 -06:00 committed by GitHub
parent 2053742b11
commit 78b319a0a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 71 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
README.md
View File

@ -1,57 +0,0 @@
# Payroll manager
#### This is a simple system to keep a record of employees where they will peform differnt tasks within the company and will be paid accordingly in a montly bases.
## Getting started
### Pre requisites
##### Installing docker
#
```sh
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
sudo apt-get update
apt-cache policy docker-ce
sudo apt-get install -y docker-ce
```
##### Installing docker compose
#
```sh
sudo curl -L https://github.com/docker/compose/releases/download/1.19.0/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
```
### Starting up
##### To initialize the system it can be run with docker compose which will create the service for apache + php and the mysql instance used by the service
#
```sh
sudo docker-compose up --build -d
```
##### Note: if the service is run without docker it'll be necesary to adjust the connection parameters in the file
#
```
api-payroll/src/settings.php
```
##### The login page can be accessed at
#
```
http://localhost:8085/public/html/login.php
```
###### Note: To access the system the user is 'sloth' while the password is 'slothness'
## For more detailed documentation about the different components:
[api-payroll](https://github.com/PootisPenserHere/payroll_manager/blob/master/api-payroll/README.md)
[database](https://github.com/PootisPenserHere/payroll_manager/blob/master/database/README.md)
### Data volumes
### Considerations when calculating the salary

71
README.rst Normal file
View File

@ -0,0 +1,71 @@
Payroll manager
##########################################################
|codebuild|
This is a simple system to keep a record of employees where they will perform different tasks within the company and will be paid accordingly in a monthly bases.
.. contents::
Getting started
-----------------
The system requires the following:
- Ubuntu 16.04
- php 7.0
- composer
- docker
- docker-compose
- mysql 5.7
Installation
-----------------
Alternatively to installing all the packages and configuring the server it's possible to start up an instance of the system with docker-compose
To install docker
.. code-block:: bash
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
sudo apt-get update
apt-cache policy docker-ce
sudo apt-get install -y docker-ce
To install docker compose
.. code-block:: bash
sudo curl -L https://github.com/docker/compose/releases/download/1.19.0/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
And finally the containers can be initialized by running
.. code-block:: bash
sudo docker-compose up --build -d
Sign in
-----------------
The login page can be accessed at **http://localhost:8085/public/html/login.php**
To access the platform the user is **sloth** and the pasword **slothness**
Further reading
-----------------
To further read about the api and it's front-end
`api-payroll <https://github.com/PootisPenserHere/payroll_manager/blob/master/api-payroll/README.rst>`_
More about the database `database <https://github.com/PootisPenserHere/payroll_manager/blob/master/database/README.rst>`_
Data volumes
-----------------
Since the application is designed to run within containers a number of volumes has been created to persist the data, they can be found in the volumes directory on the root of the project
.. |codebuild| image:: https://s3.amazonaws.com/codefactory-us-east-1-prod-default-build-badges/passing.svg
:target: https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiWm42eW80VzA2OXRTc2xIMXErZ1hlS1RpNnFCaDVMWENqSSsyU2x3dUpReEpCRUtaZGRmbklYaFN0anVEWW9NaGYvQ21PNk9tR25rZGtZMjNvR1ArbGdVPSIsIml2UGFyYW1ldGVyU3BlYyI6IjVXYjl3TWZnUVQ1MFZDQ0kiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master
:alt: Build status of the master branch on amazon codebuild