visvendra / popcommerce Goto Github PK

POP Commerce is a simple eCommerce application and an admin app to administer the eCommerce site and manage various aspects of a retail or wholesale business, from customer service and fulfillment to accounting. The goal is for POP Commerce to include all functionality a general retail business might need.

While meant to be a usable and functional, the primary purpose is to be a easy to customize starting point for custom eCommerce sites and a demonstration of the use of Moqui Framework and Mantle Business Artifacts entities and services for building eCommerce applications.

POP Commerce is based on the Moqui Framework and Mantle Business Artifacts projects. It reuses various ERP screens from the HiveMind Service ERP project.

To run POP Commerce you need Moqui Framework, Mantle Business Artifacts, and HiveMind as well as POP Commerce itself. Moqui supports a few methods for setup and deployment as described in the documentation here:

http://www.moqui.org/framework/docs/RunDeploy.html

The easiest way to try POP Commerce is with the binary distribution available on GitHub:

https://github.com/moqui/PopCommerce/releases

If you don't have gradle or ant installed you can use this command line to run Java directly:

$ java -Xmx512M -XX:MaxPermSize=128m -jar moqui-${version}.war

Note that with JDK 8 you don't need the -XX:MaxPermSize argument.

To get the latest Moqui, Mantle, and POP Commerce and run locally you'll need JDK 7 or later (Sun JDK 8 recommended), Gradle 2 or later, and either a git client or you can use the ZIP download links on each project page on GitHub. The GitHub project pages are at:

https://github.com/moqui/moqui https://github.com/moqui/mantle https://github.com/moqui/PopCommerce

Java can be downloaded here (make sure to use the Download button under the JDK column, not the under the JRE column):

http://www.oracle.com/technetwork/java/javase/downloads/index.html

Gradle can be downloaded here (use a release before 2.0 in the Previous Releases section):

http://www.gradle.org/downloads

To download Moqui/Mantle/PopCommerce source and build/run locally use the following steps:

Zip: https://github.com/moqui/moqui/archive/master.zip

Git: git://github.com/moqui/moqui.git

From either source you should have a moqui directory for the next steps. If you use the Zip download change the directory name from moqui-master to moqui.

Zip: https://github.com/moqui/mantle/archive/master.zip

Git: git://github.com/moqui/mantle.git

Put the mantle directory in the moqui/runtime directory so it is located at moqui/runtime/mantle. If you use the Zip download change the name of the directory from mantle-master to mantle to make sure the directory under the moqui/runtime directory has the correct name.

Zip: https://github.com/moqui/HiveMind/archive/master.zip

Git: git://github.com/moqui/HiveMind.git

Put the HiveMind directory in the moqui/runtime/component directory so it is located at moqui/runtime/component/HiveMind. If you use the Zip download change the name of the directory from HiveMind-master to HiveMind to make sure the directory under the moqui/runtime/component directory has the correct name.

Zip: https://github.com/moqui/PopCommerce/archive/master.zip

Git: git://github.com/moqui/PopCommerce.git

Put the PopCommerce directory in the moqui/runtime/component directory so it is located at moqui/runtime/component/PopCommerce. If you use the Zip download change the name of the directory from PopCommerce-master to PopCommerce to make sure the directory under the moqui/runtime/component directory has the correct name.

From the moqui directory run gradle load.

This will build Moqui and load data from Moqui, Mantle, HiveMind, and POP Commerce into an embedded H2 database.

From the moqui directory run gradle run.

In your browser go to:

http://localhost:8080/popc

Or for the admin application go to:

http://localhost:8080/apps/PopcAdmin

Use the button in the lower-left corner of the screen login as John Doe.

Java 8 is recommended: http://www.oracle.com/technetwork/java/javase/downloads/index.html

Gradle 2 or later recommended: http://www.gradle.org/downloads

Here are command line steps, and you can do the same thing with a Git desktop app:

$ git clone [email protected]:moqui/moqui.git moqui
$ cd moqui/runtime/
$ git clone [email protected]:moqui/mantle.git mantle
$ cd component/
$ git clone [email protected]:moqui/HiveMind.git HiveMind
$ git clone [email protected]:moqui/PopCommerce.git PopCommerce
$ cd ../.. (to the moqui directory)
$ gradle load
$ gradle run

Here are steps for a basic update:

$ cd moqui
$ git pull
$ cd runtime/mantle
$ git pull
$ cd ../component/HiveMind
$ git pull
$ cd ../PopCommerce
$ git pull
$ cd ../../.. (to the moqui directory)
$ gradle cleanAll
$ gradle load
$ gradle run

To access the eCommerce app go to something like http://localhost:8080/popc in a web browser. To access the admin app go to http://localhost:8080/PopcAdmin.