Seaso-server

Seaso spring server

Install

Install database

If you are under NTU LAN, you do not need to change the setting in application.yml. Otherwise, please install MySQL from the official website with your OS version.

Then, you shall change the setting in application.yml:

datasource:
    url: jdbc:mysql://localhost:3306/test?useUnicode=true&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC
    username: root    # this is your db username
    password: password # this is your db password
    driver-class-name: com.mysql.cj.jdbc.Driver

Install FastDFS (not required)

FastDFS is an open source high performance distributed file system (DFS). It's major functions include: file storing, file syncing and file accessing, and design for high capacity and load balance.

FastDFS consists of two parts: tracker and storage(with nginx). You may choose to deploy tracker and storage in different servers.

Unix User

For FastDFS to function, you are required to install: tracker, storage, and fastdfs-nginx-module. Here is a Chinese tutorial on how to configure FastDFS. Or you may wish fast setup by following the Fast DFS Fast Setup Guide.

Windows User

Unfortunately, FastDFS does not have a installable windows version. You may want to install a Cygwin virtual environment or install an Ubuntu virtual machine which is already available for Windows 10.

Install Elasticsearch

Elasticsearch is a highly scalable open-source full-text search and analytics engine. It allows you to store, search, and analyze big volumes of data quickly and in near real time. It is generally used as the underlying engine/technology that powers applications that have complex search features and requirements. (from elasticsearch official website)

Here we use this powerful tool to search matched question given a long text.
You are required to install elasticsearch and kibana plugin manager. Please see Installation Guide here.

Install Maven

Maven is a popular Java dependency manager. Our project is managed by Maven. Please see Setup Guide for maven setup.

Install Project dependencies

IDE User

If you are using an IDE that supported Maven, click mvn->install for installation; Click mvn->clean for a cleanup.

Other User

On the very first time of running,

mvn install

This process will take a few minutes. When there is another build/update, please remember to cleanup:

mvn clean

Run

First, run test to see if the setting is correct:

mvn test

If all tests pass, you can pack up a jar file

mvn package

Then run the jar

java -jar target/seaso-0.0.1-SNAPSHOT.jar

If you are running/testing the project under IDEA, your IDE will automatically detect the entrance.
On your first run, you have to init database data. Please run data.sql under /db/mysql/ after you startup the server.

Issues

Here is some issues you may meet during the installation.

1. Color console in Windows

With the use of log4j2, we are unable to print out a colorful log to the console in Windows platform. However, unix-like platforms work fine. It is because DOS environment does not support colors with ANSI escape codes.
This could be not user-friendly. You may wish to use a plugin Grep Console for coloring if you are running this server with IDEA IDE.

YuanmingLeee / Seaso-server