Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add development information #1106

Open
wants to merge 1 commit into
base: v1
Choose a base branch
from
Open

Add development information #1106

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<a href="https://vaddy.net/" target="_blank">
Expand Down