Skip to content

Latest commit

 

History

History

one-two-three

one-two-three

Require

  1. Java 8 or higher
  2. Apache Maven 3.3+

Description

  1. one-two-three-app-api: contains app's request controllers, app's event handlers and components that are related to app
  2. one-two-three-app-entry: contains AppEntryLoader class (you should not add any classes in this module)
  3. one-two-three-app-entry/config/config.properties: app's configuration file
  4. one-two-three-common: contains components that are used by both app and plugin
  5. 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
  6. one-two-three-plugin/config/config.properties: plugin's configuration file
  7. one-two-three-startup: contains ApplicationStartup class to run on local (you should not add any classes in this module)
  8. one-two-three-startup/src/main/resources/logback.xml: log4j configuration file

How to build?

You can build by:

  1. Running mvn clean install on your terminal
  2. Opening build.sh file and set EZYFOX_SERVER_HOME by your ezyfox-server folder path and run bash build.sh file on your terminal

How to run?

Run on your IDE

You just move to one-two-three-startup module and run ApplicationStartup

Run by ezyfox-server

To run by ezyfox-server you need to follow by steps:

  1. Download ezyfox-sever (the standard version is for IoT servers and the full version is for normal servers)
  2. Open build.sh file and set EZYFOX_SERVER_HOME variable, let's say you place ezyfox-server at /Programs/ezyfox-server so EZYFOX_SERVER_HOME=/Programs/ezyfox-server
  3. Run build.sh file on your terminal
  4. 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>
  1. Run console.sh in EZYFOX_SERVER_HOME on your terminal, if you want to run ezyfox-server in backgroud you will need to run start-server.sh on your terminal

Run without ezyfox-server

To run without ezyfox-server you need follow by steps:

  1. Run bash export.sh command
  2. Move to one-two-three-startup/deploy folder

On Windows

You just need run console.bat

On Linux

  1. To run to debug, you just need run bash console.sh on your terminal
  2. To run in background, you just need run bash start-service.sh on your terminal
  3. To stop your service, you just need run bash stop-service.sh on your terminal

Run with specific configuration profile

You can read this guide to know how to run ezyfox-server or your application with a specific profile

How to deploy?

Deploy mapping

Modules which are deployed to ezyfox-server will be mapped as follows::

  1. one-two-three-app-api => ezyfox-server/apps/common/one-two-three-app-api-1.0.0.jar
  2. one-two-three-app-entry => ezyfox-server/apps/entries/one-two-three-app
  3. one-two-three-common => ezyfox-server/common/ one-two-three-common-1.0.0.jar
  4. one-two-three-plugin => ezyfox-server/plugins/one-two-three-plugin

Deploy with tools

You can use bellow tools to copy jar files (follow by above mapping)

  1. filezilla
  2. transmit

Deploy with scp

We've already prepared for you deploy.sh file, you just need:

  1. Open deploy.sh file
  2. Set ezyfoxServerLocal by your ezyfox-server folder path on local
  3. Set ezyfoxServerRemote by your ezyfox-server folder path on remote
  4. Set sshCredential by your ssh credential, i.e root@your_host.com
  5. Run bash deploy.sh command
  6. After the deployment is done, you need to open settings/ezy-settings.xml file in ezyfox-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>

Deploy without ezyfox-server

You just need use tool or scp to copy one-two-three-startup/deploy to your server

How to test?

On your IDE, you need:

  1. Move to one-two-three-startup module
  2. Run ApplicationStartup in src/main/java
  3. Run ClientTest in src/test/java

Documentation

You can find a lot of documents on youngmonkeys.org

Contact us

Help us by donation

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/

License

  • Apache License, Version 2.0