<!doctype html>
<!--[if IE 6 ]>
<html lang="en-us" class="ie6"> <![endif]-->
<!--[if IE 7 ]>
<html lang="en-us" class="ie7"> <![endif]-->
<!--[if IE 8 ]>
<html lang="en-us" class="ie8"> <![endif]-->
<!--[if (gt IE 7)|!(IE)]><!-->
<html lang="en-us"><!--<![endif]-->
<head>
<meta charset="utf-8">
<title>HRM Saas</title>
<meta name="description" content="Description">
<meta name="author" content="Ajay">
<meta name="copyright" content="ajay138">
<meta name="generator" content="Documenter v2.0 http://rxa.li/documenter">
<meta name="date" content="2014-05-26T00:00:00+02:00">
<link href='http://fonts.googleapis.com/css?family=Open+Sans:700italic,400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="assets/css/documenter_style.css" media="all">
<link rel="stylesheet" href="assets/js/google-code-prettify/prettify.css" media="screen">
<script src="assets/js/google-code-prettify/prettify.js"></script>
<script src="assets/js/jquery.js"></script>
<script src="assets/js/jquery.scrollTo.js"></script>
<script src="assets/js/jquery.easing.js"></script>
<script src="assets/js/jquery.slimscroll.min.js"></script>
<script>document.createElement('section');
var duration = '500', easing = 'swing';
$(function () {
$("#documenter_nav li a").click(function () {
var id = $(this).attr('href');
$('#documenter_nav').find('.current').removeClass('current');
$(this).addClass('current');
$('html, body').animate({
scrollTop: $(id).offset().top
}, 2000);
});
});
</script>
<script src="assets/js/script.js"></script>
<style>
html {
background-color: #FFFFFF;
color: #383838;
}
::-moz-selection {
background: #333636;
color: #00DFFC;
}
::selection {
background: #333636;
color: #00DFFC;
}
#documenter_sidebar #documenter_logo{
background-image:url(assets/images/hrm-logo-full-white.png);
background-size: 100px;
background-color:black ;
}
a {
color: #008C9E;
}
.btn {
border-radius: 3px;
}
.btn-primary {
background-image: -moz-linear-gradient(top, #008C9E, #006673);
background-image: -ms-linear-gradient(top, #008C9E, #006673);
background-image: -webkit-gradient(linear, 0 0, 0 008 C9E%, from(#343838), to(#006673));
background-image: -webkit-linear-gradient(top, #008C9E, #006673);
background-image: -o-linear-gradient(top, #008C9E, #006673);
background-image: linear-gradient(top, #008C9E, #006673);
filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#008C9E', endColorstr='#006673', GradientType=0);
border-color: #006673 #006673 #bfbfbf;
color: #FFFFFF;
}
.btn-primary:hover,
.btn-primary:active,
.btn-primary.active,
.btn-primary.disabled,
.btn-primary[disabled] {
border-color: #008C9E #008C9E #bfbfbf;
background-color: #006673;
}
hr {
border: 1px solid #c52e2f;
}
#documenter_sidebar, #documenter_sidebar ul a {
background-color: #c52e2f;
color: #FFFFFF;
}
/* #documenter_sidebar ul a{-webkit-text-shadow:1px 1px 0px #494F4F;-moz-text-shadow:1px 1px 0px #494F4F;text-shadow:1px 1px 0px #494F4F;}*/
/* #documenter_sidebar ul{border-top:1px solid #212424;}*/
#documenter_sidebar ul a {
color: #FFFFFF;
}
#documenter_sidebar ul a:hover {
background: #444444;
}
#documenter_sidebar ul a.current {
background: #222222;
}
#documenter_copyright {
display: block !important;
visibility: visible !important;
}
.slimScrollBar {
z-index: 1000 !important;
}
</style>
</head>
<body class="documenter-project-hrm">
<div id="documenter_sidebar">
<a href="#documenter_cover" id="documenter_logo" style="height:100px"></a>
<ul id="documenter_nav">
<li><a class="current" href="#documenter_cover">Start</a></li>
<li><a href="#getting_started" title="Getting Started">Getting Started</a></li>
<li><a href="#server_requirements" title="Getting Started">Server Requirements</a></li>
<li><a href="#installation" title="Getting Started">Installation</a></li>
<li><a href="#feature" title="Getting Started">Feature</a></li>
<li><a href="#setting" title="Settings">Settings</a></li>
<li><a href="#employee_dashboard" title="dashboard">Employee Dashboard</a></li>
<li><a href="#dashboard" title="dashboard">Dashboard</a></li>
<li><a href="#employees" title="Employees">Employees</a></li>
<li><a href="#department" title="Department">Department</a></li>
<li><a href="#awards" title="Awards">Awards</a></li>
<li><a href="#expense" title="Expenses">Expense</a></li>
<li><a href="#holidays" title="Holidays">Holidays</a></li>
<li><a href="#attendance" title="attendance">Attendance</a></li>
<li><a href="#leave" title="leave">Leave Applications</a></li>
<li><a href="#language_translation" title="Client Panel">Language Translation</a></li>
<li><a href="#update" title="Update Instructions">Update Instructions</a></li>
</ul>
<div id="documenter_copyright">Copyright © Ajay138 2018<br>
</div>
</div>
<div id="documenter_content">
<section id="documenter_cover">
<img src="assets/images/default.png" height="100px"/>
<!-- <h1>HRM <small style="font-size:12px;"><br/>attendance | hr | payroll</small> </h1> -->
<div id="documenter_buttons">
</div>
<hr>
<ul>
<li>by: <a href="http://www.froiden.com/">Ajay Kumar Choudhary</a></li>
<li><a href=""></a></li>
<li>Email: <a href="mailto:ajay138@gmail.com">ajay138@gmail.com</a></li>
</ul>
</section>
<section id="getting_started">
<div class="page-header"><h3>Getting Started</h3>
<hr class="notop">
</div>
<p>Introducing HRM - a complete HR management solution to manage everything from the employees,
their attendance, office expenses and many other things.</p>
</section>
<section id="server_requirements">
<div class="page-header"><h3>Server Requirements</h3>
<hr class="notop">
</div>
<div>
The Server needs to meet the following requirement to the application.
</div>
<div>
</div>
<ol>
<li>
PHP >= 7.1.X
</li>
<li>
OpenSSL PHP Extension
</li>
<li>
PDO PHP Extension
</li>
<li>
Mbstring PHP Extension
</li>
<li>
Tokenizer PHP Extension
</li>
<li>
XML PHP Extension
</li>
<li>
GD PHP Extension
</li>
<li>
Fileinfo PHP Extension
</li>
</ol>
</section>
<section id="installation">
<div class="page-header"><h3>Installation</h3>
<hr class="notop">
</div>
<div style="white-space: normal;">
Pre-installation Requirements:
</div>
<div style="white-space: normal;">
</div>
<div style="white-space: normal;">
File System Permissions
</div>
<div style="white-space: normal;">
</div>
<div style="white-space: normal;">
To be able to start the installation at all, you must set appropriate permissions for storage folder and
it's
subfolders. So, the very first thing to do is to set permissions to 777 for storage folder, all its
subfolders.
</div>
<div style="white-space: normal;">
</div>
<div style="white-space: normal;">
After setting the permissions you are ready to proceed to the installation.
</div>
<div style="white-space: normal;">
</div>
<div style="white-space: normal;">
After downloading the ZIP archive, and uploading it to your server, the first thing you have to do is to
create the database where system tables will be created. Let's say, you create the database called <strong>hrm_saas</strong>.
</div>
<div style="white-space: normal;">
<hr>
<h2>
Step 1 - Welcome Screen</h2>
<p>
After creating the database next step is accessing the application URL from a browser. One thing you
need to know is that Laravel is designed to allow HTTP access to the application from your public folder
only. This means that this application will be available at yourdomain.com/public. It is good enough for
installation and development purposes, however, for production, you will probably want to have your
application available at yourdomain.com. In next section, I will show you how you can accomplish
that.</p>
<div class="alert alert-error" style="white-space: normal;">
<strong>Note</strong>: If you see any error check that you should have <strong>.env</strong> file at
your root location.
</div>
<p>
To open the installer. Visit </p>
<div class="alert alert-info">
<span style="font-family: Arial, verdana, arial, sans-serif;">yourdomain.com/public/install</span></div>
</div>
<div style="white-space: normal;">
</div>
<div style="white-space: normal;">
Now the installer will show up.The First screen will be Welcome Screen
</div>
<div style="white-space: normal;">
<img alt="" src="assets/images/welcome.jpg" style="width: 619px;"></div>
<div style="white-space: normal;">
</div>
<div class="alert alert-error" style="white-space: normal;">
<strong>Note</strong>: If you are not able to access the website by accessing yourdomain.com/public/install,
but you are able to access it via yourdomain.com/public/index.php/install, this means that you probably
don't
have Apache mod_rewrite installed and enabled.
</div>
<h2 style="white-space: normal;">
</h2>
<h2 style="white-space: normal;">
Step 2 - Database/Environment Setting</h2>
<p style="white-space: normal;">
On step 2 you have to fill in your database credentials </p>
<p style="white-space: normal;">
<img alt="" src="assets/images/env_setting.jpg"></p>
<h2 style="white-space: normal;">
Step 3: System Requirements</h2>
<p style="white-space: normal;">
After clicking on "Next" button, you will be redirected to System Requirements step during
the installation wizard, System Requirements.</p>
<p style="white-space: normal;">
<img alt="" src="assets/images/system.jpg" style="width: 580px;"></p>
<h2 style="white-space: normal;">
Step 4 - Directory Permissions</h2>
<div>
After successfully enabling and installing all required PHP extensions, next step is to set the appropriate
permissions for some system folders. All directories listed on step 4 has to be writable by the application,
as it is displayed on the following picture.
</div>
<div>
</div>
<div>
<img alt="" src="assets/images/perm.jpg" style="width: 580px;"></div>
<div>
</div>
<h2>
Step 5: Exit</h2>
<p>
The last step is exit step.</p>
<p>
<img alt="" src="assets/images/finish.jpg" style="width: 603px;"></p>
<div>
Now You are ready to go.
</div>
<div>
</div>
<div>
Login details are
</div>
<div>
</div>
<pre class="prettyprint lang-html linenums"><strong>Superadmin</strong>
Email: superadmin@example.com
Password:123456
</pre>
<p>
</p>
</section>
<section id="feature">
<div class="page-header"><h3>Features </h3>
<hr class="notop">
</div>
<p>HRM is a simple and easy to use software having basic minimal features. You can get started straight away
without
any training, yet having flexibility to do things your way.
</p>
<table width="100%" cellpadding="0" cellspacing="0">
<tr>
<td>
<h4>HRM Features</h4>
<ol>
<li> Employee Management</li>
<li> Expense Management</li>
<li> Department Management</li>
<li> Awards Management</li>
<li> Holidays Management</li>
<li> Attendance Management</li>
<li> Leave Types Management</li>
<li> Leave Application Management</li>
<li> Notice Board</li>
<li> General Setting</li>
<li> Profile Setting</li>
<li> Notification Setting</li>
</ol>
</td>
<td>
</td>
</tr>
</table>
</section>
<section id="setting">
<div class="page-header"><h3>Setting Up Application</h3>
<hr class="notop">
</div>
<p>After your successfull install your application, now you need to setting your app. <br/>
Log to your application and go to :
</p>
<p class="warning">
Go to : Settings » General Setting
</p>
<h4> General Setting </h4>
<p><img src="assets/images/general_settings.png" style="width:70%"/></p>
<p class="warning">
Go to : Settings » Profile Setting
</p>
<h4> Profile Setting </h4>
<p><img src="assets/images/profile_settings.png" style="width:70%"/></p>
<p class="warning">
Go to : Settings » Notification Setting
</p>
<h4> Notification Setting </h4>
<p><img src="assets/images/notification_settings.png" style="width:70%"/></p>
<p class="warning">
Go to : Settings » Theme Setting
</p>
<h4> Theme Setting </h4>
<p><img src="assets/images/theme_settings.png" style="width:70%"/></p>
</section>
<!-- Employee Dashboard -->
<section id="employee_dashboard">
<div class="page-header"><h3>NoticeBoard</h3>
<hr class="notop">
</div>
<h4> NoticeBoard view page </h4>
<p><img src="assets/images/employee_dashboard.png" style="width:70%"/></p>
</section>
<!-- Employee Dahboard Board -->
<section id="dashboard">
<div class="page-header"><h3>HRM Dashboard</h3>
<hr class="notop">
</div>
<h4> Attendance and Expense Reports</h4>
<p><img src="assets/images/dashboard.jpg" style="width:70%"/></p>
<!-- EMPLOYEES SECTION -->
<section id="employees">
<div class="page-header"><h3>Employees Page</h3>
<hr class="notop">
</div>
<p class="info">
Before Adding employee to the database.You need to add <strong>department </strong>and its <strong>designations</strong>
</p>
<h4> Employees View </h4>
<p><img src="assets/images/Employees-HRM.png" style="width:80%"/></p>
<h4> Employees Edit Page </h4>
<p><img src="assets/images/edit-employee-tts.png" style="width:80%"/></p>
</section>
<!-- EMPLOYEES SECTION -->
<!-- DEPARTMENT SECTION -->
<section id="department">
<div class="page-header"><h3>Department</h3>
<hr class="notop">
</div>
<h4> Department View </h4>
<p><img src="assets/images/department-tts.png" style="width:80%"/></p>
<h4> Department Add Page </h4>
<p><img src="assets/images/department-add.png" style="width:80%"/></p>
<h4> Department Edit Page </h4>
<p><img src="assets/images/department-edit.png" style="width:80%"/></p>
</section>
<!-- DEPARTMENT SECTION -->
<!-- Awards SECTION -->
<section id="awards">
<div class="page-header"><h3>Awards</h3>
<hr class="notop">
</div>
<h4> Awards create Page </h4>
<p><img src="assets/images/award-tts.png" style="width:80%"/></p>
</section>
<!-- Awards SECTION -->
<!-- Expense SECTION -->
<section id="expense">
<div class="page-header"><h3>Expense</h3>
<hr class="notop">
</div>
<h4> Expense create Page </h4>
<p><img src="assets/images/expense-tts.png" style="width:80%"/></p>
</section>
<!-- Expense SECTION -->
<!-- Holdays SECTION -->
<section id="holidays">
<div class="page-header"><h3>Holidays</h3>
<hr class="notop">
</div>
<h4> Awards create Page </h4>
<p><img src="assets/images/holidays-tts.png" style="width:70%"/></p>
</section>
<!-- Holidays SECTION -->
<!-- Attendance SECTION -->
<section id="attendance">
<div class="page-header"><h3>Attendance</h3>
<hr class="notop">
</div>
<h4> View Attendance all Page </h4>
<p><img src="assets/images/view-attendnace.png" style="width:80%"/></p>
<h4> LeaveTypes pages </h4>
<p><img src="assets/images/leave-type-tts.png" style="width:80%"/></p>
</section>
<!-- Attendance SECTION -->
<!-- Leave Applications -->
<section id="leave">
<div class="page-header"><h3>Leave Applications</h3>
<hr class="notop">
</div>
<h4> Leave application Accept Page </h4>
<p><img src="assets/images/leave.jpg"/></p>
</section>
<section id="language_translation">
<div class="page-header"><h3>Language Translation</h3>
<hr class="notop">
</div>
<p>
You can change the translations if required using the translation manager.
</p>
<h2>
Step 1</h2>
<p>Login as superadmin and the visit <b>Settings -> Translation Manager</b></p>
<p>
Visit <i><strong>yourdomain.com/translations</strong></i>.</p>
<p>
<img alt="" src="assets/images/image_35.png" style="width: 800px; "></p>
<p>
</p>
<h2>
Step 2</h2>
<p>
Your all translations are arranged in groups. Choose a group from dropdown to change the translations.
<br>You will a see list of translations for each language for every group you select.</p>
<p>
<img alt="" src="assets/images/image_36.png" style="width: 800px; "></p>
<p>
</p>
<h2>
Step 3</h2>
<p>
1. Now to change the translation string click on the string and you will see a popup to change it. <br>2.
Change the string and click on blue check button.
<br>3. Similarly do it for all strings you want to change.</p>
<p>
<img alt="" src="assets/images/image_37.png" style="width: 800px; "></p>
<p>
</p>
<h2>
Step 4</h2>
<p>
Now just click on the <strong>Publish translations</strong> button on top to apply the changes.</p>
</section>
<!-- Leave Applications -->
<section id="update">
<div class="page-header"><h3>Update Instructions</h3>
<hr class="notop">
</div>
<p>
To update to new version of the worksuite follow these steps in sequence.
<ol>
<li>Take back up of your files and database before updating.</li>
<li>Replace all the files and folders except the <code><strong>.env, public/uploads</strong></code></li>
<li>After replacing the files go to this link <code><strong>http://www.yourdomain.com/update-new-version</strong>. Click update now</code></li>
<li>You should see a update success message.</li>
<li>Login to see the new version.</li>
</ol>
</p>
</section>
</div>
</body>
</html>