feat: Initialize HRMS App

.github/workflows/ci.yml

@@ -0,0 +1,90 @@
+
+name: CI
+
+on:
+  push:
+    branches:
+      - develop
+  pull_request:
+
+concurrency:
+  group: develop-hrms-${{ github.event.number }}
+  cancel-in-progress: true
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    name: Server
+
+    services:
+      mariadb:
+        image: mariadb:10.3
+        env:
+          MYSQL_ROOT_PASSWORD: root
+        ports:
+          - 3306:3306
+        options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3
+
+    steps:
+      - name: Clone
+        uses: actions/checkout@v2
+
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14
+          check-latest: true
+
+      - name: Cache pip
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/*requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+            ${{ runner.os }}-
+
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: 'echo "::set-output name=dir::$(yarn cache dir)"'
+
+      - uses: actions/cache@v2
+        id: yarn-cache
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      - name: Setup
+        run: |
+          pip install frappe-bench
+          bench init --skip-redis-config-generation --skip-assets --python "$(which python)" ~/frappe-bench
+          mysql --host 127.0.0.1 --port 3306 -u root -proot -e "SET GLOBAL character_set_server = 'utf8mb4'"
+          mysql --host 127.0.0.1 --port 3306 -u root -proot -e "SET GLOBAL collation_server = 'utf8mb4_unicode_ci'"
+
+      - name: Install
+        working-directory: /home/runner/frappe-bench
+        run: |
+          bench get-app hrms $GITHUB_WORKSPACE
+          bench setup requirements --dev
+          bench new-site --db-root-password root --admin-password admin test_site
+          bench --site test_site install-app hrms
+          bench build
+        env:
+          CI: 'Yes'
+
+      - name: Run Tests
+        working-directory: /home/runner/frappe-bench
+        run: |
+          bench --site test_site set-config allow_tests true
+          bench --site test_site run-tests --app hrms
+        env:
+          TYPE: server

.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+*.pyc
+*.egg-info
+*.swp
+tags
+hrms/docs/current
+node_modules/

MANIFEST.in

@@ -0,0 +1,18 @@
+include MANIFEST.in
+include requirements.txt
+include *.json
+include *.md
+include *.py
+include *.txt
+recursive-include hrms *.css
+recursive-include hrms *.csv
+recursive-include hrms *.html
+recursive-include hrms *.ico
+recursive-include hrms *.js
+recursive-include hrms *.json
+recursive-include hrms *.md
+recursive-include hrms *.png
+recursive-include hrms *.py
+recursive-include hrms *.svg
+recursive-include hrms *.txt
+recursive-exclude hrms *.pyc

README.md

@@ -0,0 +1,7 @@
+## HRMS
+
+Modern HR and Payroll Software
+
+#### License
+
+GNU General Public License

hrms/__init__.py

@@ -0,0 +1,3 @@
+
+__version__ = '0.0.1'
+

hrms/config/desktop.py

@@ -0,0 +1,10 @@
+from frappe import _
+
+def get_data():
+	return [
+		{
+			"module_name": "HRMS",
+			"type": "module",
+			"label": _("HRMS")
+		}
+	]

hrms/config/docs.py

@@ -0,0 +1,10 @@
+"""
+Configuration for docs
+"""
+
+# source_link = "https://github.com/[org_name]/hrms"
+# headline = "App that does everything"
+# sub_heading = "Yes, you got that right the first time, everything"
+
+def get_context(context):
+	context.brand_html = "HRMS"

hrms/hooks.py

@@ -0,0 +1,195 @@
+from . import __version__ as app_version
+
+app_name = "hrms"
+app_title = "HRMS"
+app_publisher = "Frappe"
+app_description = "Modern HR and Payroll Software"
+app_email = "[email protected]"
+app_license = "GNU General Public License"
+
+# Includes in <head>
+# ------------------
+
+# include js, css files in header of desk.html
+# app_include_css = "/assets/hrms/css/hrms.css"
+# app_include_js = "/assets/hrms/js/hrms.js"
+
+# include js, css files in header of web template
+# web_include_css = "/assets/hrms/css/hrms.css"
+# web_include_js = "/assets/hrms/js/hrms.js"
+
+# include custom scss in every website theme (without file extension ".scss")
+# website_theme_scss = "hrms/public/scss/website"
+
+# include js, css files in header of web form
+# webform_include_js = {"doctype": "public/js/doctype.js"}
+# webform_include_css = {"doctype": "public/css/doctype.css"}
+
+# include js in page
+# page_js = {"page" : "public/js/file.js"}
+
+# include js in doctype views
+# doctype_js = {"doctype" : "public/js/doctype.js"}
+# doctype_list_js = {"doctype" : "public/js/doctype_list.js"}
+# doctype_tree_js = {"doctype" : "public/js/doctype_tree.js"}
+# doctype_calendar_js = {"doctype" : "public/js/doctype_calendar.js"}
+
+# Home Pages
+# ----------
+
+# application home page (will override Website Settings)
+# home_page = "login"
+
+# website user home page (by Role)
+# role_home_page = {
+#	"Role": "home_page"
+# }
+
+# Generators
+# ----------
+
+# automatically create page for each record of this doctype
+# website_generators = ["Web Page"]
+
+# Jinja
+# ----------
+
+# add methods and filters to jinja environment
+# jinja = {
+# 	"methods": "hrms.utils.jinja_methods",
+# 	"filters": "hrms.utils.jinja_filters"
+# }
+
+# Installation
+# ------------
+
+# before_install = "hrms.install.before_install"
+# after_install = "hrms.install.after_install"
+
+# Uninstallation
+# ------------
+
+# before_uninstall = "hrms.uninstall.before_uninstall"
+# after_uninstall = "hrms.uninstall.after_uninstall"
+
+# Desk Notifications
+# ------------------
+# See frappe.core.notifications.get_notification_config
+
+# notification_config = "hrms.notifications.get_notification_config"
+
+# Permissions
+# -----------
+# Permissions evaluated in scripted ways
+
+# permission_query_conditions = {
+# 	"Event": "frappe.desk.doctype.event.event.get_permission_query_conditions",
+# }
+#
+# has_permission = {
+# 	"Event": "frappe.desk.doctype.event.event.has_permission",
+# }
+
+# DocType Class
+# ---------------
+# Override standard doctype classes
+
+# override_doctype_class = {
+# 	"ToDo": "custom_app.overrides.CustomToDo"
+# }
+
+# Document Events
+# ---------------
+# Hook on document methods and events
+
+# doc_events = {
+# 	"*": {
+# 		"on_update": "method",
+# 		"on_cancel": "method",
+# 		"on_trash": "method"
+#	}
+# }
+
+# Scheduled Tasks
+# ---------------
+
+# scheduler_events = {
+# 	"all": [
+# 		"hrms.tasks.all"
+# 	],
+# 	"daily": [
+# 		"hrms.tasks.daily"
+# 	],
+# 	"hourly": [
+# 		"hrms.tasks.hourly"
+# 	],
+# 	"weekly": [
+# 		"hrms.tasks.weekly"
+# 	],
+# 	"monthly": [
+# 		"hrms.tasks.monthly"
+# 	],
+# }
+
+# Testing
+# -------
+
+# before_tests = "hrms.install.before_tests"
+
+# Overriding Methods
+# ------------------------------
+#
+# override_whitelisted_methods = {
+# 	"frappe.desk.doctype.event.event.get_events": "hrms.event.get_events"
+# }
+#
+# each overriding function accepts a `data` argument;
+# generated from the base implementation of the doctype dashboard,
+# along with any modifications made in other Frappe apps
+# override_doctype_dashboards = {
+# 	"Task": "hrms.task.get_dashboard_data"
+# }
+
+# exempt linked doctypes from being automatically cancelled
+#
+# auto_cancel_exempted_doctypes = ["Auto Repeat"]
+
+
+# User Data Protection
+# --------------------
+
+# user_data_fields = [
+# 	{
+# 		"doctype": "{doctype_1}",
+# 		"filter_by": "{filter_by}",
+# 		"redact_fields": ["{field_1}", "{field_2}"],
+# 		"partial": 1,
+# 	},
+# 	{
+# 		"doctype": "{doctype_2}",
+# 		"filter_by": "{filter_by}",
+# 		"partial": 1,
+# 	},
+# 	{
+# 		"doctype": "{doctype_3}",
+# 		"strict": False,
+# 	},
+# 	{
+# 		"doctype": "{doctype_4}"
+# 	}
+# ]
+
+# Authentication and authorization
+# --------------------------------
+
+# auth_hooks = [
+# 	"hrms.auth.validate"
+# ]
+
+# Translation
+# --------------------------------
+
+# Make link fields search translated document names for these DocTypes
+# Recommended only for DocTypes which have limited documents with untranslated names
+# For example: Role, Gender, etc.
+# translated_search_doctypes = []

hrms/modules.txt

@@ -0,0 +1 @@
+HRMS

license.txt

@@ -0,0 +1 @@
+License: GNU General Public License

requirements.txt

@@ -0,0 +1 @@
+# frappe -- https://github.com/frappe/frappe is installed via 'bench init'

setup.py

@@ -0,0 +1,19 @@
+from setuptools import setup, find_packages
+
+with open("requirements.txt") as f:
+	install_requires = f.read().strip().split("\n")
+
+# get version from __version__ variable in hrms/__init__.py
+from hrms import __version__ as version
+
+setup(
+	name="hrms",
+	version=version,
+	description="Modern HR and Payroll Software",
+	author="Frappe",
+	author_email="[email protected]",
+	packages=find_packages(),
+	zip_safe=False,
+	include_package_data=True,
+	install_requires=install_requires
+)