Skip to content

Latest commit

 

History

History
378 lines (287 loc) · 12.8 KB

README.md

File metadata and controls

378 lines (287 loc) · 12.8 KB
Raw

vue version element-ui Docker Pulls Publish GH Action license GitHub release Gitter

English | Spanish

Introduction.

adempiere-vue is a new UI for ADempiere ERP, CRM & SCM]. It based on vue and use the UI Toolkit element-ui.

POS Image

It is a great UI for ADempiere ERP, CRM & SCM based on the newest development stack of vue, built-in i18n solution, typical templates for enterprise applications, lots of awesome features. This project was forked from Vue-Element-Admin originally write by PanJiaChen / 花裤衩 over MIT license and was changed to GNU/GPL v3 by Yamel Senih after forked granted by PanJiaChen / 花裤衩 on issue "Extend as GNU/Gpl v3 License #1434".

adempiere-vue use the modern open source high performance RPC framework that can run in any environment gRPC as server.

The current version is v1.0+ build on vue-cli. If you find a problem, please put issue.

This project does not support low version browsers (e.g. IE). Please add polyfill by yourself.

Preparation

You need to install node and git locally. The project is based on ES2015+, vue, vuex, vue-router, vue-cli , gRPC and element-ui. Understanding and learning this knowledge in advance will greatly help the use of this project.

Edit on CodeSandbox

For all enviroment you should run the follow images:

docker pull erpya/adempiere-grpc-all-in-one
docker pull erpya/proxy-adempiere-api
docker pull erpya/adempiere-vue

Run docker container:

Minimal Docker Requirements

To use this Docker image you must have your Docker engine release number greater than or equal to 3.0.

Build docker image (for development only):

docker build -t erpya/adempiere-vue:dev -f ./Dockerfile .

Download docker image:

docker pull erpya/adempiere-vue

Run container container:

docker run -it \
	--name adempiere-vue \
	-p 80:80 \
	-e API_URL="https://api.erpya.com" \
	erpya/adempiere-vue

Environment variables for the configuration

  • API_URL: It indicates the address of the server to which you will point the service Proxy-Adempiere-Api, by default its value is https://https://api.erpya.com.

NOTE: If you do not change the values of the environment variables, it is not necessary to indicate them in the docker run command, since the default values will be set.

Run docker container with docker-compose:

Or easy run container using docker-compose with follow command:

docker-compose up

Terminal output:

Building web-client
Step 1/8 : FROM node:12-alpine
 ---> 057fa4cc38c2
Step 2/8 : LABEL maintainer="[email protected]"       description="ADempiere-Vue"
 ---> Running in d096cf76ce2d
Removing intermediate container d096cf76ce2d
 ---> 46cc05704121
Step 3/8 : ENV RELEASE_VERSION="3.9.3"
 ---> Running in 9048d159aaf9
Removing intermediate container 9048d159aaf9
 ---> a19699234a5d
Step 4/8 : ENV URL_REPO="https://github.com/adempiere/adempiere-vue"    BINARY_NAME="v$RELEASE_VERSION.zip"     VUE_APP_PROXY_ADDRESS="localhost"       VUE_APP_PROXY_PORT="8989"
 ---> Running in c703a3818cbf
Removing intermediate container c703a3818cbf
 ---> 86b0c2b269c6
Step 5/8 : RUN mkdir -p /opt/Apps &&    cd /opt/Apps &&         echo "Install needed packages... $BINARY_NAME $RELEASE_VERSION" &&      apk --no-cache add curl unzip &&        curl --output "$BINARY_NAME" -L "$URL_REPO/archive/$BINARY_NAME" &&     unzip -o "$BINARY_NAME" &&      rm "$BINARY_NAME" &&    mv "adempiere-vue-$RELEASE_VERSION" adempiere-vue &&    cd adempiere-vue &&    npm install &&   npm run build:prod
 ---> Running in 6f3cb21924dd
Install needed packages... v3.9.3.zip 3.9.3
fetch http://dl-cdn.alpinelinux.org/alpine/v3.11/main/x86_64/APKINDEX.tar.gz
fetch http://dl-cdn.alpinelinux.org/alpine/v3.11/community/x86_64/APKINDEX.tar.gz
(1/5) Installing ca-certificates (20191127-r2)
(2/5) Installing nghttp2-libs (1.40.0-r1)
(3/5) Installing libcurl (7.67.0-r0)
(4/5) Installing curl (7.67.0-r0)
(5/5) Installing unzip (6.0-r6)
Executing busybox-1.31.1-r9.trigger
Executing ca-certificates-20191127-r2.trigger
OK: 9 MiB in 21 packages
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   128  100   128    0     0    149      0 --:--:-- --:--:-- --:--:--   149
100  916k    0  916k    0     0   180k      0 --:--:--  0:00:05 --:--:--  254k
Archive:  v3.9.3.zip
1d684b76328e3f6bcd3f75ea011087cce1c13a3c
   creating: adempiere-vue-3.9.3/
  inflating: adempiere-vue-3.9.3/.babelrc
  inflating: adempiere-vue-3.9.3/.editorconfig
adempiere-ui-client |
adempiere-ui-client | > Listening at  http://localhost:9526/

Sponsors

ERP Consultores y Asociados

Become a sponsor and get your logo on our README on GitHub with a link to your site. Become a sponsor

Features

- Login / Logout
- Register
- Forgot Password

- Permission Authentication
  - ADempiere backend permission
  - Page permission
  - Directive permission
  - Permission configuration page

- Multi-environment build
  - Develop (dev)
  - sit
  - Stage Test (stage)
  - Production (prod)

- Global Features
  - I18n
  - Multiple dynamic themes
  - Dynamic sidebar (supports multi-level routing)
  - Dynamic breadcrumb
  - Tags-view (Tab page Support right-click operation)
  - Svg Sprite
  - Screenfull
  - Responsive Sidebar

- Editor
  - Rich Text Editor
  - Markdown Editor
  - JSON Editor

- Excel
  - Export Excel
  - Upload Excel
  - Visualization Excel
  - Export zip

- Table
  - Dynamic Table
  - Drag And Drop Table
  - Inline Edit Table

- Error Page
  - 401
  - 404

- Components
  - Avatar Upload
  - Back To Top
  - Drag Dialog
  - Drag Select
  - Drag Kanban
  - Drag List
  - SplitPane
  - Dropzone
  - Sticky
  - CountTo

- ADempiere supported
  - Window
  - Process
  - Report
  - Smart Browser
  - Form
  - Workflow

- Advanced Example
- Error Log
- Dashboard
- Guide Page
- ECharts
- Clipboard
- Markdown to html

Getting started

Use gRPC ADempiere Server as gRPC provider.

# clone the project
git clone -b develop [email protected]:adempiere/adempiere-vue-.git

# enter the project directory
cd adempiere-vue

# install dependency
yarn install

# develop
yarn dev

This will automatically open http://localhost:9527

Build

# build for test environment
yarn build:stage

# build for production environment
yarn build:prod

Advanced

# preview the release environment effect
yarn preview

# preview the release environment effect + static resource analysis
yarn preview --report

# code format check
yarn lint

# code format check and auto fix
yarn lint --fix

Refer to Documentation for more information

Docker Container

# requires superuser permissions of the operating system ('su' or 'sudo')
docker-compose up

Changelog

Detailed changes for each release are documented in the release notes.

Online Demo

Preview

  • User: demo
  • Password: demo

Donate

If you find this project useful, you can help this make a better UI

Paypal Me

Some Contributors

Thanks you for any effort to improve this great project. The follows are some companies that paying for help us to make a best software.

vDevSoft

Browsers support

Modern browsers and Internet Explorer 10+

IE / Edge
IE / Edge		 Firefox
Firefox		 Chrome
Chrome		 Safari
Safari
IE10, IE11, Edge last 2 versions last 2 versions last 2 versions

License

GNU/GPL v3

Previous License

MIT

Initial Contributors