From f03a0d80153bb3bb8080d64db09cebc063374e4b Mon Sep 17 00:00:00 2001 From: ruthra kumar Date: Wed, 11 Dec 2024 12:40:53 +0530 Subject: [PATCH 1/4] Update README.md --- README.md | 86 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 61 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 4f65ceb70bd..e10eb515f38 100644 --- a/README.md +++ b/README.md @@ -16,37 +16,41 @@ -ERPNext as a monolith includes the following areas for managing businesses: +# ERPNext -1. [Accounting](https://erpnext.com/open-source-accounting) -1. [Warehouse Management](https://erpnext.com/distribution/warehouse-management-system) -1. [CRM](https://erpnext.com/open-source-crm) -1. [Sales](https://erpnext.com/open-source-sales-purchase) -1. [Purchase](https://erpnext.com/open-source-sales-purchase) -1. [HRMS](https://erpnext.com/open-source-hrms) -1. [Project Management](https://erpnext.com/open-source-projects) -1. [Support](https://erpnext.com/open-source-help-desk-software) -1. [Asset Management](https://erpnext.com/open-source-asset-management-software) -1. [Quality Management](https://erpnext.com/docs/user/manual/en/quality-management) -1. [Manufacturing](https://erpnext.com/open-source-manufacturing-erp-software) -1. [Website Management](https://erpnext.com/open-source-website-builder-software) -1. [Customize ERPNext](https://erpnext.com/docs/user/manual/en/customize-erpnext) -1. [And More](https://erpnext.com/docs/user/manual/en/) +100% OpenSource ERP system to help you run your business. -ERPNext is built on the [Frappe Framework](https://github.com/frappe/frappe), a full-stack web app framework built with Python & JavaScript. +## Key Features -## Installation +- **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. -
- - - - - Try in PWD - +## 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. + +
+ + + + Try on Frappe Cloud + +
-> Login for the PWD site: (username: Administrator, password: admin) + ### Containerized Installation @@ -59,6 +63,38 @@ The Easy Way: our install script for bench will install all dependencies (e.g. M 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. From 687894584f57b84512fdb792724965998b586dfd Mon Sep 17 00:00:00 2001 From: ruthra kumar Date: Wed, 11 Dec 2024 12:46:24 +0530 Subject: [PATCH 2/4] chore(readme): update links --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e10eb515f38..cf38843b151 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,12 @@ [![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) -[https://erpnext.com](https://erpnext.com) - +
+ Live Demo + - + Website + - + Documentation
# ERPNext From 644c48ba46ff19101d588f42a24966651153ba53 Mon Sep 17 00:00:00 2001 From: ruthra kumar Date: Wed, 11 Dec 2024 12:51:59 +0530 Subject: [PATCH 3/4] chore: add end tag --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index cf38843b151..0348df43c11 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ [![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) +
Live Demo - From d9408eae4483d4e57fb3e0a29283992a46dc8f79 Mon Sep 17 00:00:00 2001 From: ruthra kumar Date: Wed, 11 Dec 2024 12:55:41 +0530 Subject: [PATCH 4/4] chore: footer logo --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 0348df43c11..8b268625942 100644 --- a/README.md +++ b/README.md @@ -122,6 +122,17 @@ The ERPNext code is licensed as GNU General Public License (v3) and the Document 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). + +

+
+ + + + Frappe Technologies + + +