Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
147 changes: 128 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,150 @@
# Employee Self Service
<div align="center">
<h1>Nesscale ESS</h1>
<p>Employee Self Service for ERPNext</p>

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Frappe](https://img.shields.io/badge/Frappe-Framework-orange.svg)](https://frappeframework.com)

<p>
<a href="https://apps.apple.com/app/nesscale-ess/id6450770577">iOS App</a> •
<a href="https://play.google.com/store/apps/details?id=com.nesscale.ess">Android App</a> •
<a href="https://ess.nesscale.app">Website</a>
</p>
</div>

## Description
---

Employee Self-Service is a Frappe app that allows employees to access and manage their own HR-related information and perform various self-service tasks. This app requires ERPNext and HRMS to be installed and running. Additionally, the chat feature of Frappe (Frappe's Chat application) is required for certain functionalities.
## What is this?

This is the backend component for Nesscale ESS - a mobile app that brings ERPNext to your phone. Employees can manage their HR tasks, sales activities, and projects right from their mobile devices.

**This repo is open source** (GPL v3.0) and provides the server-side APIs. The mobile apps are available separately on the App Store and Play Store.

📱 **Download the mobile app:**
- [iOS App Store](https://apps.apple.com/app/nesscale-ess/id6450770577)
- [Google Play Store](https://play.google.com/store/apps/details?id=com.nesscale.ess)

> Trusted by 100+ clients • 10k+ downloads • 4.8★ rating

---

## Features

**HR & Attendance**
- Apply for leaves and track approvals
- Check-in/check-out with geo-fencing
- Offline attendance support
- View salary slips and attendance history
- Submit expense claims

**Sales & CRM**
- Create sales orders and quotations
- Manage customer visits
- Track sales activities

**Tasks & Projects**
- Assign and manage tasks
- Track project progress
- Approve workflows on the go

**Other Features**
- Real-time push notifications
- Multilingual support
- Biometric authentication
- Posts, polls, and team updates

---

## Installation

1. **Prerequisites**
You need ERPNext and HRMS installed on your server. Then:

**1. Get the app**

```bash
# For version 13
bench get-app https://github.com/nesscale-com/employee_self_service.git --branch version-13

# For version 14
bench get-app https://github.com/nesscale-com/employee_self_service.git --branch version-14

Before installing the Employee Self-Service app, make sure you have the following requirements met:
- Frappe framework is installed and set up on your system.
- ERPNext and HRMS are installed and configured.
# For version 15
bench get-app https://github.com/nesscale-com/employee_self_service.git --branch version-15

2. **Install the App**
# For version 16
bench get-app https://github.com/nesscale-com/employee_self_service.git --branch version-16
```

Run the following commands to install the Employee Self-Service app:<br/>
- <b>bench get-app https://github.com/nesscale-com/employee_self_service.git --branch version-14</b><br/>
- <b>bench --site <site_name> install-app employee_self_service</b>
**2. Install on your site**

```bash
bench --site [your-site-name] install-app employee_self_service
bench --site [your-site-name] migrate
bench restart
```

**3. Configure**

Note: Replace `<site_name>` with the name of your Frappe site.
Go to **Setup > Employee Self Service Settings** in your ERPNext desk and configure permissions and notifications.

3. **Run Bench Migrate**
**4. Connect mobile app**

After the installation, run the following command to migrate the database:
Download the mobile app and login with your ERPNext credentials. That's it!

bench migrate
---

## Version Compatibility

| Branch | Frappe/ERPNext Version |
|--------|----------------------|
| version-13 | 13.x |
| version-14 | 14.x |
| version-15 | 15.x |
| version-16 | 16.x (latest) |

---

## Support

Need help? We're here for you:

- 📧 Email: [info@nesscale.com](mailto:info@nesscale.com)
- 🌐 Website: [ess.nesscale.app](https://ess.nesscale.app)
- 🐛 Issues: [GitHub Issues](https://github.com/nesscale-com/employee_self_service/issues)

For enterprise support, custom features, or training, drop us an email.

---

## Contributing

We welcome contributions! Feel free to:
- Report bugs or suggest features via GitHub Issues
- Submit pull requests
- Help improve documentation

---

## License

Employee Self Service is distributed under the GNU/General Public License. See the LICENSE file for more information.
**Backend (this repo):** Open source under GPL v3.0 - use it freely, modify it, share it.

**Mobile apps:** Proprietary software - see [Terms of Service](https://ess.nesscale.app/terms)

---

## About

Built with ❤️ by [Nesscale](https://nesscale.com) using the Frappe Framework.

## Support and Contact
We build practical solutions that make ERPNext more accessible and easier to use for everyday tasks.

For any issues, questions, or feedback, please feel free to reach out via email: [info@nesscale.com](mailto:your_info@nesscale.com)
---

for more details visit https://ess.nesscale.app
<div align="center">
<p>
<a href="https://ess.nesscale.app">Website</a> •
<a href="mailto:info@nesscale.com">Contact</a> •
<a href="https://github.com/nesscale-com/employee_self_service">GitHub</a>
</p>
</div>