erpnext README

The project's README from github.com/frappe/erpnext. As one markdown file: README.md.

ERPNext Logo

ERPNext

Powerful, Intuitive and Open-Source ERP

Learn on Frappe School

CI docker pulls

ERPNext Hero Image
Live Demo - Website - Documentation

ERPNext

100% Open-Source ERP System to help you run your business.

Motivation

Running a business is a complex task - handling invoices, tracking stock, managing personnel, and other daily operations. In a market where software is sold separately to manage each of these tasks, ERPNext does all of the above and more, for free.

Key Features

More

Under the Hood

Production Setup

Managed Hosting

You can try Frappe Cloud, a simple, user-friendly, and sophisticated open-source platform to host Frappe applications reliably and securely.

It handles 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

Self-Hosted

Docker

See Frappe Docker Documentation for full documentation & FAQ on Docker setup

Prerequisites

For Docker basics and best practices refer to Docker's documentation

Try on your environment

⚠️ Disposable demo only

This setup is intended for quick evaluation. Expect to throw the environment away. You will not be able to install custom apps to this setup. For production deployments, custom configurations, and detailed explanations, see the full documentation.

First clone the repo:

git clone https://github.com/frappe/frappe_docker
cd frappe_docker

Then run:

docker compose -f pwd.yml up -d

Wait for a couple of minutes for ERPNext site to be created or check the create-site container logs before opening browser on port 8080. (username: Administrator, password: admin)

See Frappe Docker for ARM based docker setup

Development Setup

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:

  1. Setup bench by following the Installation Steps 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

  3. Get the ERPNext app and install it

    # Get the ERPNext app
bench get-app https://github.com/frappe/erpnext

# Install the app
bench --site erpnext.localhost install-app erpnext

  4. Open the URL http://erpnext.localhost:8000/app in your browser, you should see the app running

Learning and Community

  1. Frappe School - Learn Frappe Framework and ERPNext from the various courses by the maintainers or from the community.
  2. Official documentation - Extensive documentation for ERPNext.
  3. Discussion Forum - Engage with the community of ERPNext users and service providers.
  4. Telegram Group - Get instant help from huge community of users.

Contributing

  1. Issue Guidelines
  2. Report Security Vulnerabilities
  3. Pull Request Requirements
  4. Translations

Logo and Trademark Policy

Please read our Logo and Trademark Policy.



Frappe Technologies

erpnext (frappe/erpnext)

Searching Database…

40.3K ·GitHub
Erpnext
What is this?ERPNext is a free, open-source Enterprise Resource Planning system that helps run a business: accounting, inventory/orders, manufacturing, asset management, projects, CRM, HR and more in one app.
Is this a standalone app or built on another framework?ERPNext is a full application built on top of the Frappe Framework (Python/JavaScript full-stack web framework) and uses Frappe UI, a Vue-based component library, for its interface.
How do I get it running?For a quick disposable demo, clone the frappe_docker repo and run the provided docker command, then open port 8080. For real development or production, use the bench install script or Frappe Cloud for managed hosting.
What do I need installed first?Docker and Docker Compose v2 plus git for the Docker setup, or MariaDB and other bench dependencies (installed automatically by the install script) for a manual setup.
Is the quick Docker setup ready for production?No — the one-command Docker setup is explicitly meant only for quick evaluation and throwaway testing; you can't install custom apps on it, and production needs the full documentation's custom configuration.
Who is ERPNext meant for?Businesses that need accounting, order management, manufacturing, asset management and project tracking without paying for separate software for each function.
Where does ERPNext run?It's a self-hosted web app accessed through the browser, deployable via Docker or bench, or hosted for you on Frappe Cloud.
What default login do I get with the demo setup?Username 'Administrator' and password 'admin' for the quick Docker demo.
Can I manage multiple ERPNext deployments easily?Yes, Frappe Cloud is a fully featured developer platform that lets you manage and control multiple Frappe deployments with monitoring and maintenance handled for you.
Does ERPNext support ARM-based servers?Yes, Frappe Docker provides documentation for ARM-based Docker setups.
What are similar projects?aureuserp, odoo, platform, akaunting, frappe, nocobase, illa-builder, laravel-crm
Which topics is it in?erp, accounting, manufacturing, healthcare, crm, project-management, mysql, vue, cloud, database, ui, web-app
Creator
frappe
Size
1.9 GB
Stars
40.3K
Updated
CommitOct 16Releasev16.51.1Oct 15
Age
15y
Commits · 90 Days