Files

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

160 lines
6.4 KiB
Markdown
Raw Permalink Normal View History

<div align="center">
<a href="https://frappe.io/erpnext">
2024-12-12 17:09:22 +05:30
<img src="./erpnext/public/images/v16/erpnext.svg" alt="ERPNext Logo" height="80px" width="80xp"/>
2022-07-26 13:09:46 +05:30
</a>
<h2>ERPNext</h2>
<p align="center">
2024-12-11 20:28:15 +05:30
<p>Powerful, Intuitive and Open-Source ERP</p>
2022-07-26 13:09:46 +05:30
</p>
2024-02-06 11:31:11 +05:30
[![CI](https://github.com/frappe/erpnext/actions/workflows/server-tests-mariadb.yml/badge.svg?event=schedule)](https://github.com/frappe/erpnext/actions/workflows/server-tests-mariadb.yml)
2022-07-26 13:09:46 +05:30
[![docker pulls](https://img.shields.io/docker/pulls/frappe/erpnext-worker.svg)](https://hub.docker.com/r/frappe/erpnext-worker)
2024-12-11 12:51:59 +05:30
</div>
2024-12-12 17:09:22 +05:30
<div align="center">
2024-12-16 17:33:43 +05:30
<img src="./erpnext/public/images/v16/hero_image.png"/>
2024-12-12 17:09:22 +05:30
</div>
2024-12-11 12:46:24 +05:30
<div align="center">
2025-03-05 15:47:20 +05:30
<a href="https://erpnext-demo.frappe.cloud/api/method/erpnext_demo.erpnext_demo.auth.login_demo">Live Demo</a>
2024-12-11 12:46:24 +05:30
-
<a href="https://frappe.io/erpnext">Website</a>
2024-12-11 12:46:24 +05:30
-
<a href="https://docs.frappe.io/erpnext/">Documentation</a>
</div>
2024-12-16 14:54:04 +05:30
## ERPNext
2024-12-11 12:40:53 +05:30
2024-12-11 20:28:15 +05:30
100% Open-Source ERP system to help you run your business.
2024-12-11 12:40:53 +05:30
2024-12-17 13:09:16 +05:30
### Motivation
2024-12-16 14:54:04 +05:30
2024-12-16 17:33:43 +05:30
Running a business is a complex task - handling invoices, tracking stock, managing personnel and even more ad-hoc activities. In a market where software is sold separately to manage each of these tasks, ERPNext does all of the above and more, for free.
2024-12-16 14:54:04 +05:30
2024-12-12 17:09:22 +05:30
### Key Features
2024-12-11 12:40:53 +05:30
- **Accounting**: All the tools you need to manage cash flow in one place, right from recording transactions to summarizing and analyzing financial reports.
- **Order Management**: Track inventory levels, replenish stock, and manage sales orders, customers, suppliers, shipments, deliverables, and order fulfillment.
- **Manufacturing**: Simplifies the production cycle, helps track material consumption, exhibits capacity planning, handles subcontracting, and more!
- **Asset Management**: From purchase to perishment, IT infrastructure to equipment. Cover every branch of your organization, all in one centralized system.
2024-12-11 20:28:15 +05:30
- **Projects**: Delivery both internal and external Projects on time, budget and Profitability. Track tasks, timesheets, and issues by project.
2024-12-19 10:43:36 +05:30
<details open>
2024-12-17 14:42:51 +05:30
<summary>More</summary>
<img src="https://erpnext.com/files/v16_bom.png"/>
<img src="https://erpnext.com/files/v16_stock_summary.png"/>
<img src="https://erpnext.com/files/v16_job_card.png"/>
<img src="https://erpnext.com/files/v16_tasks.png"/>
</details>
2024-12-11 12:40:53 +05:30
2024-12-12 17:09:22 +05:30
### Under the Hood
2024-12-11 12:40:53 +05:30
- [**Frappe Framework**](https://github.com/frappe/frappe): A full-stack web application framework written in Python and Javascript. The framework provides a robust foundation for building web applications, including a database abstraction layer, user authentication, and a REST API.
- [**Frappe UI**](https://github.com/frappe/frappe-ui): A Vue-based UI library, to provide a modern user interface. The Frappe UI library provides a variety of components that can be used to build single-page applications on top of the Frappe Framework.
## Production Setup
### Managed Hosting
You can try [Frappe Cloud](https://frappecloud.com), a simple, user-friendly and sophisticated [open-source](https://github.com/frappe/press) platform to host Frappe applications with peace of mind.
It takes care of installation, setup, upgrades, monitoring, maintenance and support of your Frappe deployments. It is a fully featured developer platform with an ability to manage and control multiple Frappe deployments.
<div>
2024-12-12 17:09:22 +05:30
<a href="https://erpnext-demo.frappe.cloud/app/home" target="_blank">
2024-12-11 12:40:53 +05:30
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://frappe.io/files/try-on-fc-white.png">
<img src="https://frappe.io/files/try-on-fc-black.png" alt="Try on Frappe Cloud" height="28" />
</picture>
</a>
2022-07-26 13:09:46 +05:30
</div>
2021-04-23 13:06:13 +05:30
2024-12-11 12:40:53 +05:30
2014-02-15 15:23:25 +05:30
2024-12-17 13:09:16 +05:30
### Self-Hosted
2024-12-11 20:28:15 +05:30
#### Docker
2014-03-13 20:45:27 +05:30
2024-12-16 17:33:43 +05:30
Prerequisites: docker, docker-compose, git. Refer [Docker Documentation](https://docs.docker.com) for more details on Docker setup.
Run following commands:
```
git clone https://github.com/frappe/frappe_docker
cd frappe_docker
docker compose -f pwd.yml up -d
```
After a couple of minutes, site should be accessible on your localhost port: 8080. Use below default login credentials to access the site.
- Username: Administrator
- Password: admin
See [Frappe Docker](https://github.com/frappe/frappe_docker?tab=readme-ov-file#to-run-on-arm64-architecture-follow-this-instructions) for ARM based docker setup.
2014-02-15 15:23:25 +05:30
2024-12-17 13:09:16 +05:30
## Development Setup
2022-07-26 13:09:46 +05:30
### Manual Install
2011-09-08 14:16:34 +05:30
2022-07-26 13:09:46 +05:30
The Easy Way: our install script for bench will install all dependencies (e.g. MariaDB). See https://github.com/frappe/bench for more details.
2012-06-08 15:19:26 +05:30
2022-07-26 13:09:46 +05:30
New passwords will be created for the ERPNext "Administrator" user, the MariaDB root user, and the frappe user (the script displays the passwords and saves them to ~/frappe_passwords.txt).
2024-12-11 12:40:53 +05:30
### Local
To setup the repository locally follow the steps mentioned below:
2024-12-11 20:33:34 +05:30
1. Setup bench by following the [Installation Steps](https://frappeframework.com/docs/user/en/installation) and start the server
```
bench start
```
2. In a separate terminal window, run the following commands:
```
# Create a new site
bench new-site erpnext.localhost
2024-12-11 20:33:34 +05:30
```
2024-12-12 17:09:22 +05:30
3. Get the ERPNext app and install it
2024-12-11 20:33:34 +05:30
```
2024-12-12 17:09:22 +05:30
# Get the ERPNext app
2024-12-11 20:33:34 +05:30
bench get-app https://github.com/frappe/erpnext
2024-12-11 20:33:34 +05:30
# Install the app
bench --site erpnext.localhost install-app erpnext
2024-12-11 20:33:34 +05:30
```
4. Open the URL `http://erpnext.localhost:8000/app` in your browser, you should see the app running
2024-12-11 12:40:53 +05:30
2022-07-26 13:09:46 +05:30
## Learning and community
2022-07-26 13:09:46 +05:30
1. [Frappe School](https://frappe.school) - Learn Frappe Framework and ERPNext from the various courses by the maintainers or from the community.
2. [Official documentation](https://docs.erpnext.com/) - Extensive documentation for ERPNext.
3. [Discussion Forum](https://discuss.erpnext.com/) - Engage with community of ERPNext users and service providers.
2023-02-21 13:05:03 +05:30
4. [Telegram Group](https://erpnext_public.t.me) - Get instant help from huge community of users.
2021-10-05 12:49:08 +05:30
2022-07-26 13:09:46 +05:30
## Contributing
2022-07-26 13:09:46 +05:30
1. [Issue Guidelines](https://github.com/frappe/erpnext/wiki/Issue-Guidelines)
1. [Report Security Vulnerabilities](https://erpnext.com/security)
1. [Pull Request Requirements](https://github.com/frappe/erpnext/wiki/Contribution-Guidelines)
2011-09-08 14:16:34 +05:30
2024-12-11 12:55:41 +05:30
2022-07-26 13:09:46 +05:30
## Logo and Trademark Policy
2011-09-08 14:16:34 +05:30
2022-07-26 13:09:46 +05:30
Please read our [Logo and Trademark Policy](TRADEMARK_POLICY.md).
2024-12-11 12:55:41 +05:30
2024-12-12 17:09:22 +05:30
<br />
<br />
2024-12-11 12:55:41 +05:30
<div align="center" style="padding-top: 0.75rem;">
<a href="https://frappe.io" target="_blank">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://frappe.io/files/Frappe-white.png">
<img src="https://frappe.io/files/Frappe-black.png" alt="Frappe Technologies" height="28"/>
</picture>
</a>
</div>