From 7ca6141ccbd824bdb055caa470d679e46a4d9131 Mon Sep 17 00:00:00 2001 From: y-okumura-isp Date: Tue, 9 Mar 2021 21:07:45 +0900 Subject: [PATCH] Add development information --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 57eccc6b6..d0c8edcfb 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,37 @@ ## How to initial set up - Please show the [wiki page](https://github.com/support-project/knowledge/wiki) + +## Developer manual + +### Build with Eclipse & Tomcat + +You can read how to develop with Eclipse & Tomcat by [this article](http://koda3.hatenablog.com/entry/2015/04/08/061130). +Here is a short summary: + +- Import to Eclipse + - Download Eclipse + - Clone this repository + - Run Eclipse, specify JRE 1.8 + - Import Knowledge directory by "File > Import > Maven > Existing Maven Projects" +- Run in Eclipse + - Download tomcat v8 + - Set up tomcat v8 according to Eclipse Servers view + - Add tomcat to Eclipse + - Right click and start +- Access to http://localhost:8080/knowledge + +### Build manually + +You can create war file by `launch.sh` with some modifications. +Also you need docker and docker-compose. +See https://github.com/support-project/knowledge/pull/1100 about `launch.sh` modifications. + + +### ER diagram + +You can see ER diagram at document/database (in Japanese). + ## vulnerability testing - vulnerability testing with VAddy