ilscipio / scipio-erp

A scalable large-scale eCommerce framework that is made for multinational omnichannel installations and is easy to customize.
https://www.scipioerp.com
Apache License 2.0
335 stars 182 forks source link
bootstrap bulma cms crm ecommerce ecommerce-framework ecommerce-platform ecommerce-store ecommerce-website erp foundation java open-source pos user-management
**************************************************************************

   _____    _____   _   _____    _    ____      _____   _____    _____
  / ____|  / ____| | | |  __ \  | |  / __ \    |  ___| |  __ \  |  __ \
 | (___   | |      | | | |__) | | | | |  | |   | |___  | |__) | | |__) |
  \___ \  | |      | | |  ___/  | | | |  | |   |  ___| |  _  /  |  ___/
  ____) | | |____  | | | |      | | | |__| |   | |___  | | \ \  | |
 |_____/   \_____| |_| |_|      |_|  \____/    |_____| |_|  \_\ |_|

                    https://www.scipioerp.com

**************************************************************************

PRs Welcome Maintainability Read the Docs

SCIPIO ERP - Community Edition

Scipio ERP is a toolkit for the development of modern business applications.

What is Scipio ERP

Scipio ERP is an Open Source Business Application Toolkit based on Java 11+ and a built-in Tomcat application server. We provide standard applications, functions (services) and a well thought-out datamodel, so that you can create modern web applications.

Our templating toolkit simplifies the creation of modern UIs and is compatible with most modern HTML frameworks.

Technologies

TL;DR

What's included

Installation

System Requirements

Software Requirements

Recommended Development Tools

Prerequisites

In order to install SCIPIO ERP, the following prerequisites must be installed:

Download

The standard way to get SCIPIO ERP is to checkout the master (main) branch, which provides you with the latest stable version with important updates:

  1. Open your command line and run:

Note it is also possible to checkout specific version tags as well as stable version series this way (e.g., git checkout 3.0.0), but main branch typically contains the desirable setup for most demo, server and client usages.

Installation Process

In order to install on a client system or start on a server, the following steps should be used:

  1. Open your command line, go to the extracted folder and run:

    • Linux ./install.sh
    • OS X: ./install.sh
    • Windows: install.bat
  2. From the same command line run:

    • Linux ./start.sh
    • OS X: bash ./start.sh
    • Windows: start.bat
  3. To access the application visit the SCIPIO ERP Dashboard: https://localhost:8443/admin

  4. To access the SCIPIO ERP applications from the Dashboard use: Username: admin Password: scipio

If build failure occurs due to missing Nashorn Javascript engine on JDK 15 or later, first run:

Note: These steps are typically too limited for developers; see section below.

                 **Congratulations, you have installed SCIPIO ERP!**

Updates

  1. Retrieve latest code updates from git: a. git checkout master b. git pull

  2. Reload visual themes: a. Restart SCIPIO server b. Visit entity utility services page: https://localhost:8443/admin/control/EntityUtilityServices c. Click "Visual Theme Resources - Reload All, Now"

Optional Configuration

https://www.scipioerp.com/community/developer/installation-configuration/configuration/

Addons

Community and enterprise SCIPIO ERP addons can be added to your working copy and updated using the 'git-addons' Bash script in the project root. It requires a Bash 4-compatible terminal (Linux, Mac, Windows Git Bash, Cygwin).

Instructions can be found at:

https://www.scipioerp.com/community/end-user/addons/

or for brief help and command list, type:

./git-addons help

Docker

We also provide Docker images if you would like to try out Scipio with minimal effort. To create a fully functional SCIPIO ERP instance with some demo data already loaded, you can create a container with the following command:

docker create -p 8080:8080 -p 8443:8443 ilscipio/scipio-erp:demo

Development

For developers, the install/start commands above are typically too limited. The JetBrains IntelliJ IDEA integrated development environment with Scipio ERP Plugin (found in the integrated IDEA plugin store) is highly recommended and, for compilation and development tasks, the traditional bundled Apache Ant commands may and sometimes should be used instead:

  1. Clear local database (Derby), clean out old JARs, build, load demo data to database and start:
    • Linux: ./ant clean-all build load-demo start-debug
    • OS X: ./ant clean-all build load-demo start-debug
    • Windows: ant.bat clean-all build load-demo start-debug

If build failure occurs due to missing Nashorn Javascript engine on JDK 15 or later, first run:

Commands can be listed using: ant -p (./ant -p)

Commonly used and useful Ant developer commands:

This is a quick cheat sheet and further information for developers can be found on the website documentation.

Automatically Download Jar Sources

In order for build, lib-update and lib-update-force commands to automatically download third-party JAR sources under component libsrc folders for their corresponding binaries under lib, simply create a file named "build.scp.local.properties" under project root that sets "lib.update.sources=true".

After build/lib-update-force is run, IntelliJ IDEA using the Scipio ERP plugin can be instructed to refer to these sources and automatically expand into them using Ctrl+B (a good test is HttpServletRequest):

See build.properties for other options; build.scp.local.properties and other *.scp.local.properties files are ignored for version control by .gitignore.

Support

For detailed information and changes about the SCIPIO ERP suite, visit the official website at:

https://www.scipioerp.com

You can get in touch with the us at:

https://www.ilscipio.com

OFBiz

Scipio ERP is a fork of the Apache OFBiz project.

For more details about OFBiz please visit the OFBiz Documentation page:

http://ofbiz.apache.org/documentation.html

License

The source code that makes up The SCIPIO ERP Community Edition (hereinafter referred to as "SCIPIO ERP") and the majority of the libraries distributed with it are licensed under the Apache License v2.0.

Other licenses used by libraries distributed with SCIPIO ERP are listed in the LICENSE file. This file includes a list of all libraries distributed with SCIPIO ERP and the full text of the license used for each.

For additional details, see the NOTICE file.

Disclaimer

This software is provided as is and free of charge. There is no warranty or support implied under the terms of the license included.

SCIPIO ERP and the SCIPIO logo are trademarks of Ilscipio GmbH. © Copyright SCIPIO components 2016 Ilscipio GmbH. Apache OFBiz, Apache, the Apache feather logo are trademarks of The Apache Software Foundation.

BIS Crypto TSU exception notice

This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See http://www.wassenaar.org/ for more information.

The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache Software Foundation distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.

The following provides more details on the included cryptographic software:

* Various classes in Scipio, including DesCrypt, HashCrypt, and
 BlowFishCrypt use libraries from the Sun Java JDK API including
 java.security.* and javax.crypto.* (the JCE, Java Cryptography
 Extensions API)
* Other classes such as HttpClient and various related ones use
 the JSSE (Java Secure Sockets Extension) API