# voj
**Repository Path**: SegmentMirror/voj
## Basic Information
- **Project Name**: voj
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-07-16
- **Last Updated**: 2020-12-19
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
Version: 0.2.0 (Released on August 30, 2018)
[](https://travis-ci.org/hzxie/voj)
[](https://ci.appveyor.com/project/hzxie/voj)
[](https://coveralls.io/github/hzxie/voj?branch=master)
[](http://hub.docker.com/r/zjhzxhz)
[](https://lgtm.com/projects/g/hzxie/voj/context:java)
[](https://lgtm.com/projects/g/hzxie/voj/alerts/)
[**Official Website**](https://verwandlung.org) |
[**Tech Support**](https://infinitescript.com/project/verwandlung-online-judge/) |
[**Change Log**](https://github.com/hzxie/voj/commits/master)
**Update:** Verwandlung Online Judge now supports Docker.
You can use Verwandlung Online Judge with ONLY 4 bash commands.
```
docker pull zjhzxhz/voj.web
docker pull zjhzxhz/voj.judger
docker run -d --name voj.web -p 8080:8080 zjhzxhz/voj.web
docker run -d --name voj.judger --link voj.web zjhzxhz/voj.judger
```
[Tell me more](https://github.com/hzxie/voj/tree/master/docker) about voj@Docker.
---
## Introduction
It is a cross-platform online judge system based on [Spring MVC Framework](http://spring.io).
The application used following open-source projects:
- [Spring MVC](http://spring.io) famework
- [MyBatis](https://mybatis.github.io/mybatis-3/index.html) persistence framework
- [Apache ActiveMQ](http://activemq.apache.org/) message queue
- [Druid](https://github.com/alibaba/druid/) database connection pool
- [Flat UI](http://designmodo.github.io/Flat-UI/)
- [jQuery](http://jquery.com)
- [FontAwesome](http://fontawesome.io)
- [CodeMirror](http://codemirror.net)
- [Highlight.js](https://highlightjs.org/)
### The Origin of Verwandlung
In 2011, LinkedIn Inc. released a message queue named [Kafka](http://kafka.apache.org/).
It's implemented in Scala and open-sourced.
In 2012, Alibaba Inc. released a message queue named [MetaQ](https://github.com/killme2008/Metamorphosis), which is based on Kafka.
It's implemented in Java.
MetaQ stands for *Metamorphosis*, which is a famous literature written by the author Franz Kafka.
As the message queue is one of the important components in the application, so I named the application *Verwandlung*, which is the German name of *Metamorphosis*.
### Architecture
The application contains two components:
- Web Application
- Judger (Support both Windows and Linux)
The architecture can be described as the figure below.
As you see, Verwandling Online Judge supports multiple judgers.
The judgers communicate with the web application through ActiveMQ.
---
## Getting Started
### System Requirements
#### Hardware Requirements
- **CPU**: 2.0 GHz or faster 32-bit (x86) or 64-bit (x64) processor
For Web Application (including Database and Message Queue):
- **RAM**: 2.0 GB RAM on Windows, 1.0 GB RAM on Linux.
For Judger:
- **RAM**: 1.0 GB RAM on Windows, 512 MB RAM on Linux.
#### Software Requirements
For Web Application (including Database and Message Queue):
- **Operating System**: Windows, Linux or Mac
- **Database**: [MySQL](http://www.mysql.com) 5.5+ or [MariaDB](https://mariadb.org/) 5.5+
- **Java Runtime**: [Oracle JRE](http://java.oracle.com) 1.8+ or [Oracle JDK](http://java.oracle.com) 1.8+
- **Message Queue**: [ActiveMQ](http://activemq.apache.org) 5.11+
- **Web Server**: [Tomcat](http://tomcat.apache.org) 8.5+
For Judger:
- **Operating System**: Windows or Linux
- **Java Runtime**: [Oracle JRE](http://java.oracle.com) 1.8+ or [Oracle JDK](http://java.oracle.com) 1.8+
### Installation
#### Docker Releases (Recommended)
Now you can easily use Verwandlung Online Judge with Docker.
See the installation instructions [here](https://github.com/hzxie/voj/tree/master/docker).
#### Binary Releases
- **Web Application**: [0.2.0](https://github.com/hzxie/voj/releases/download/0.2.0/voj.war)
- **Judger (Windows, 64 Bit)**: [0.2.0](https://github.com/hzxie/voj/releases/download/0.2.0/voj-judger-windows-x64.jar)
- **Judger (Linux, 64 Bit)**: [0.2.0](https://github.com/hzxie/voj/releases/download/0.2.0/voj-judger-linux-x64.jar)
#### Source Releases
**NOTE:**
- [Maven](http://maven.apache.org) 3+ and [GCC](http://gcc.gnu.org/) 4.8+ with **POSIX thread model** is required.
- Make sure `mvn` (Maven), `g++` and `make` are added to the PATH.
After download source code from this repository, run following commands from a terminal:
For Web Application:
```
cd web
mvn package -DskipTests
```
If the build is successful, the terminal will display a message as following:
```
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 10.168 s
[INFO] Finished at: 2015-11-26T13:20:09+08:00
[INFO] Final Memory: 24M/210M
[INFO] ------------------------------------------------------------------------
```
And you'll get a package named `voj.web.war` in the `target` folder.
For Judger:
**Windows**:
```
cd %JAVA_HOME%\include\win32
copy jawt_md.h ..
copy jni_md.h ..
cd judger
mvn package -DskipTests
```
**Linux**:
```
cd $JAVA_HOME/include/linux
cp jawt_md.h jni_md.h ..
cd SOURCE_CODE_PATH/judger
mvn package -DskipTests
```
If the build is successful, the terminal will display a message as following:
```
[INFO] Executing tasks
jni:
[echo] Generating JNI headers
[exec] mkdir -p target/cpp
[exec] g++ -c -std=c++11 -Wall -fPIC -I ... -o target/cpp/Judger.Core.Runner.o
[INFO] Executed tasks
...
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 12.432 s
[INFO] Finished at: 2015-11-26T13:22:46+08:00
[INFO] Final Memory: 81M/513M
[INFO] ------------------------------------------------------------------------
```
And you'll get a package named `voj.judger.jar` in the `target` folder.
### Configuration
#### Setup the ActiveMQ
To reduce the memory of ActiveMQ, you can edit `activemq.xml` in `ACTIVEMQ_HOME\conf`.
Please find following content in this file, and change it to proper values that suitable for your servers.
```
```
#### Setup the Web Application
Create a database in MySQL, import `voj.sql`.
Edit the values in `/WEB-INF/classes/voj.properties` of the file `voj.web.war`.
You can open it with archive manager software such as `WinRAR`.
After then, you can copy this file `voj.web.war` to `TOMCAT_HOME/webapps`.
**IMPORTANT:** For Windows users, please edit `server.xml` of your Tomcat configuration:
```
```
#### Setup the Judger
Edit the values in `/voj.properties` of the file `voj.judger.jar`.
You can run the judger using following command :
**Windows**:
```
javaw -jar voj.judger.jar
```
**Linux**:
```
sudo java -jar voj.judger.jar
```
**Important:**
If you are using Linux, please run following commands using `root`:
```
# Shutdown and Kill process is not allowed for non-root user
chmod 700 /sbin/init
chmod 700 /sbin/poweroff
chmod 700 /usr/bin/pkill
```
---
### Contribution
We're glad that you want to improve this project.
- **We NEED TRANSLATORS** for multi-language support(English and Chinese have supported).
- You can report bugs [here](https://github.com/hzxie/voj/issues).
- You can also create a pull request if you can fix the bug.
- If you want to add features to the project, please tell us in the [issues](https://github.com/hzxie/voj/issues) page before developing.
Thanks for your corporation.
### License
This project is open sourced under GNU GPL v3.