mirror of
https://github.com/frappe/erpnext.git
synced 2026-05-31 10:49:09 +00:00
Merge pull request #44663 from ruthra-kumar/update_readme
chore: update readme
This commit is contained in:
67
README.md
67
README.md
@@ -4,12 +4,10 @@
|
|||||||
</a>
|
</a>
|
||||||
<h2>ERPNext</h2>
|
<h2>ERPNext</h2>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<p>ERP made simple</p>
|
<p>Powerful, Intuitive and Open-Source ERP</p>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
[](https://github.com/frappe/erpnext/actions/workflows/server-tests-mariadb.yml)
|
[](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://hub.docker.com/r/frappe/erpnext-worker)
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@@ -23,7 +21,7 @@
|
|||||||
|
|
||||||
# ERPNext
|
# ERPNext
|
||||||
|
|
||||||
100% OpenSource ERP system to help you run your business.
|
100% Open-Source ERP system to help you run your business.
|
||||||
|
|
||||||
## Key Features
|
## Key Features
|
||||||
|
|
||||||
@@ -31,6 +29,9 @@
|
|||||||
- **Order Management**: Track inventory levels, replenish stock, and manage sales orders, customers, suppliers, shipments, deliverables, and order fulfillment.
|
- **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!
|
- **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.
|
- **Asset Management**: From purchase to perishment, IT infrastructure to equipment. Cover every branch of your organization, all in one centralized system.
|
||||||
|
- **Projects**: Delivery both internal and external Projects on time, budget and Profitability. Track tasks, timesheets, and issues by project.
|
||||||
|
|
||||||
|
<a href="https://erpnext.com">And More</a>
|
||||||
|
|
||||||
## Under the Hood
|
## Under the Hood
|
||||||
|
|
||||||
@@ -57,7 +58,8 @@ It takes care of installation, setup, upgrades, monitoring, maintenance and supp
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Containerized Installation
|
### Self-hosting
|
||||||
|
#### Docker
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
@@ -72,33 +74,30 @@ New passwords will be created for the ERPNext "Administrator" user, the MariaDB
|
|||||||
|
|
||||||
To setup the repository locally follow the steps mentioned below:
|
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
|
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:
|
||||||
bench start
|
```
|
||||||
```
|
# Create a new site
|
||||||
|
bench new-site erpnext.dev
|
||||||
|
|
||||||
|
# Map your site to localhost
|
||||||
|
bench --site erpnext.dev add-to-hosts
|
||||||
|
```
|
||||||
|
|
||||||
|
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 2**: In a separate terminal window, run the following commands:
|
4. Open the URL `http://erpnext.dev:8000/app` in your browser, you should see the app running
|
||||||
|
|
||||||
```
|
|
||||||
# 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
|
## Learning and community
|
||||||
|
|
||||||
@@ -114,14 +113,6 @@ bench --site erpnext.dev install-app erpnext
|
|||||||
1. [Report Security Vulnerabilities](https://erpnext.com/security)
|
1. [Report Security Vulnerabilities](https://erpnext.com/security)
|
||||||
1. [Pull Request Requirements](https://github.com/frappe/erpnext/wiki/Contribution-Guidelines)
|
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
|
## Logo and Trademark Policy
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user