- Java 8 or higher
- Apache Maven 3.3+
- one-two-three-app-api: contains app's request controllers, app's event handlers and components that are related to app
- one-two-three-app-entry: contains AppEntryLoader class (you should not add any classes in this module)
- one-two-three-app-entry/config/config.properties: app's configuration file
- one-two-three-common: contains components that are used by both app and plugin
- one-two-three-plugin: contains plugin's event handlers, plugin's request controllers and components that are related
to plugin. You will need handle
USER_LOGIN
event here - one-two-three-plugin/config/config.properties: plugin's configuration file
- one-two-three-startup: contains ApplicationStartup class to run on local (you should not add any classes in this module)
- one-two-three-startup/src/main/resources/logback.xml: log4j configuration file
You can build by:
- Running
mvn clean install
on your terminal - Opening
build.sh
file and setEZYFOX_SERVER_HOME
by yourezyfox-server
folder path and runbash build.sh
file on your terminal
You just move to one-two-three-startup
module and run ApplicationStartup
To run by ezyfox-server
you need to follow by steps:
- Download ezyfox-sever (the standard version is for IoT servers and the full version is for normal servers)
- Open
build.sh
file and setEZYFOX_SERVER_HOME
variable, let's say you placeezyfox-server
at/Programs/ezyfox-server
soEZYFOX_SERVER_HOME=/Programs/ezyfox-server
- Run
build.sh
file on your terminal - Open file
EZYFOX_SERVER_HOME/settings/ezy-settings.xml
and add to<zones>
tag:
<zone>
<name>one-two-three</name>
<config-file>one-two-three-zone-settings.xml</config-file>
<active>true</active>
</zone>
- Run
console.sh
inEZYFOX_SERVER_HOME
on your terminal, if you want to runezyfox-server
in backgroud you will need to runstart-server.sh
on your terminal
To run without ezyfox-server
you need follow by steps:
- Run
bash export.sh
command - Move to
one-two-three-startup/deploy
folder
You just need run console.bat
- To run to debug, you just need run
bash console.sh
on your terminal - To run in background, you just need run
bash start-service.sh
on your terminal - To stop your service, you just need run
bash stop-service.sh
on your terminal
You can read this guide to know how to
run ezyfox-server
or your application with a specific profile
Modules which are deployed to ezyfox-server will be mapped as follows::
- one-two-three-app-api =>
ezyfox-server/apps/common/one-two-three-app-api-1.0.0.jar
- one-two-three-app-entry =>
ezyfox-server/apps/entries/one-two-three-app
- one-two-three-common =>
ezyfox-server/common/ one-two-three-common-1.0.0.jar
- one-two-three-plugin =>
ezyfox-server/plugins/one-two-three-plugin
You can use bellow tools to copy jar files (follow by above mapping)
We've already prepared for you deploy.sh
file, you just need:
- Open
deploy.sh
file - Set
ezyfoxServerLocal
by yourezyfox-server
folder path on local - Set
ezyfoxServerRemote
by yourezyfox-server
folder path on remote - Set
sshCredential
by your ssh credential, i.eroot@your_host.com
- Run
bash deploy.sh
command - After the deployment is done, you need to open
settings/ezy-settings.xml
file inezyfox-server
on remote and add (if you have already done this step in the past, please skip it):
<zone>
<name>one-two-three</name>
<config-file>one-two-three-zone-settings.xml</config-file>
<active>true</active>
</zone>
You just need use tool or scp
to copy one-two-three-startup/deploy
to your server
On your IDE, you need:
- Move to
one-two-three-startup
module - Run
ApplicationStartup
insrc/main/java
- Run
ClientTest
insrc/test/java
You can find a lot of documents on youngmonkeys.org
- Touch us on Facebook
- Ask us on stackask.com
Currently, our operating budget is depending on our salary, every effort still based on voluntary contributions from a few members of the organization. But with a low budget like that, it causes many difficulties for us. With big plans and results being intellectual products for the community, we hope to receive your support to take further steps. Thank you very much.
https://youngmonkeys.org/donate/
- Apache License, Version 2.0