mirror of
https://github.com/frappe/erpnext.git
synced 2026-02-15 15:45:01 +00:00
123 lines
5.4 KiB
Markdown
123 lines
5.4 KiB
Markdown
<div align="center">
|
|
<a href="https://erpnext.com">
|
|
<img src="https://raw.githubusercontent.com/frappe/erpnext/develop/erpnext/public/images/erpnext-logo.png" height="128">
|
|
</a>
|
|
<h2>ERPNext</h2>
|
|
<p align="center">
|
|
<p>ERP made simple</p>
|
|
</p>
|
|
|
|
[](https://github.com/frappe/erpnext/actions/workflows/server-tests-mariadb.yml)
|
|
[](https://www.codetriage.com/frappe/erpnext)
|
|
[](https://codecov.io/gh/frappe/erpnext)
|
|
[](https://hub.docker.com/r/frappe/erpnext-worker)
|
|
|
|
[https://erpnext.com](https://erpnext.com)
|
|
|
|
</div>
|
|
|
|
# ERPNext
|
|
|
|
100% OpenSource ERP system to help you run your business.
|
|
|
|
## Key Features
|
|
|
|
- **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.
|
|
|
|
## Under the Hood
|
|
|
|
- [**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>
|
|
<a href="https://frappecloud.com/insights/signup" target="_blank">
|
|
<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>
|
|
</div>
|
|
|
|
|
|
|
|
### Containerized Installation
|
|
|
|
Use docker to deploy ERPNext in production or for development of [Frappe](https://github.com/frappe/frappe) apps. See https://github.com/frappe/frappe_docker for more details.
|
|
|
|
### Manual Install
|
|
|
|
The Easy Way: our install script for bench will install all dependencies (e.g. MariaDB). See https://github.com/frappe/bench for more details.
|
|
|
|
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).
|
|
|
|
|
|
### Local
|
|
|
|
To setup the repository locally follow the steps mentioned below:
|
|
|
|
**Step 1**: Setup bench by following the [Installation Steps](https://frappeframework.com/docs/user/en/installation) and start the server
|
|
|
|
```
|
|
bench start
|
|
```
|
|
|
|
**Step 2**: In a separate terminal window, run the following commands:
|
|
|
|
```
|
|
# Create a new site
|
|
bench new-site erpnext.dev
|
|
|
|
# Map your site to localhost
|
|
bench --site erpnext.dev add-to-hosts
|
|
```
|
|
|
|
**Step 3**: Get the Insights app and install it
|
|
|
|
```
|
|
# Get the Insights app
|
|
bench get-app https://github.com/frappe/erpnext
|
|
|
|
# Install the app
|
|
bench --site erpnext.dev install-app erpnext
|
|
```
|
|
|
|
**Step 4**: Open the URL `http://erpnext.dev:8000/app` in your browser, you should see the app running
|
|
|
|
## Learning and community
|
|
|
|
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.
|
|
4. [Telegram Group](https://erpnext_public.t.me) - Get instant help from huge community of users.
|
|
|
|
|
|
## Contributing
|
|
|
|
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)
|
|
|
|
## License
|
|
|
|
GNU/General Public License (see [license.txt](license.txt))
|
|
|
|
The ERPNext code is licensed as GNU General Public License (v3) and the Documentation is licensed as Creative Commons (CC-BY-SA-3.0) and the copyright is owned by Frappe Technologies Pvt Ltd (Frappe) and Contributors.
|
|
|
|
By contributing to ERPNext, you agree that your contributions will be licensed under its GNU General Public License (v3).
|
|
|
|
## Logo and Trademark Policy
|
|
|
|
Please read our [Logo and Trademark Policy](TRADEMARK_POLICY.md).
|