From a79301762830880258356afb6368b3500cebc449 Mon Sep 17 00:00:00 2001 From: ruthra kumar Date: Wed, 11 Dec 2024 20:28:15 +0530 Subject: [PATCH 1/2] chore: update readme --- README.md | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 8b268625942..c004ae8cd76 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,10 @@

ERPNext

-

ERP made simple

+

Powerful, Intuitive and Open-Source ERP

[![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) -[![Open Source Helpers](https://www.codetriage.com/frappe/erpnext/badges/users.svg)](https://www.codetriage.com/frappe/erpnext) -[![codecov](https://codecov.io/gh/frappe/erpnext/branch/develop/graph/badge.svg?token=0TwvyUg3I5)](https://codecov.io/gh/frappe/erpnext) [![docker pulls](https://img.shields.io/docker/pulls/frappe/erpnext-worker.svg)](https://hub.docker.com/r/frappe/erpnext-worker) @@ -23,7 +21,7 @@ # ERPNext -100% OpenSource ERP system to help you run your business. +100% Open-Source ERP system to help you run your business. ## Key Features @@ -31,6 +29,9 @@ - **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. +- **Projects**: Delivery both internal and external Projects on time, budget and Profitability. Track tasks, timesheets, and issues by project. + +And More ## 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. @@ -114,14 +116,6 @@ bench --site erpnext.dev install-app erpnext 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 From 4c68fa46e7bcea5bbf579db9550e620f8ce71dae Mon Sep 17 00:00:00 2001 From: ruthra kumar Date: Wed, 11 Dec 2024 20:33:34 +0530 Subject: [PATCH 2/2] chore: use numbered list --- README.md | 47 ++++++++++++++++++++++------------------------- 1 file changed, 22 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index c004ae8cd76..92e12d507a8 100644 --- a/README.md +++ b/README.md @@ -74,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: -**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 + ``` -``` -bench start -``` +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 + ``` + +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: - -``` -# 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 +4. Open the URL `http://erpnext.dev:8000/app` in your browser, you should see the app running ## Learning and community