Bachelor thesis "Design Decisions as Project Planning Instrument" (Entwurfsentscheidungen als Projektplanungsinstrument - EEPPI) implementation by Laurin Murer and Tobias Blaser.
- EEPPI API Documentation
The description for the API is generated on runtime by reflection and can be found at /rest/api/documentation.
- Productive installation
- Hosting Server, recommended Linux
- Database if you won't use the inmemory database of play
- JDK Version 1.8.0_25+
- Lates Build of EEPPI
- Server: See Additional configuration of Play.
- Client: The configuration in /public/configuration/application.js and /configuration/paths.js are rewritable by /public/configuration/custom.js. Add your configuration there.
- Client visual appearance: Add style rules to /public/configuration/custom.css to rewrite the visual appearance of EEPPI, e.g. to integrate EEPPI in your corporation intranet.
-
Get and unzip the latest build
-
run
bin/eeppi
on Unix orbin/eeppi.bat
on Windows -
Find EEPPI at http://localhost:9000 or the port you configured
-
Data import / export
The EEPPI application is independent of the choosen persistence.
- Inmemory DB: Simply copy the db file to another EEPPI installation to get your data to an other installation
- Hosted database, e.g. PostgreSQL, MariaDB: Use the shipped dumping tools to export and import your data.
- Development
-
JDK Version 1.8.0_25
-
Typescript compiler
- Install Node.js
- Linux:
sudo apt-get install nodejs
- Windows / Mac OS X: [http://nodejs.org/download/]
- Install Typescript compiler
- Linux/Mac OS X:
sudo npm install -g typescript
-
Firefox to run client tests and behaviour tests (selenium tests)
- Install Firefox
-
(optional) Buildserver / Buildserver UI: If you would like to build EEPPI using a build server like Jenkins, you need to install a graphical user interface to run the client tests and the selenium tests.
- Linux:
sudo apt-get install xvfb
- Linux:
-
Play Framework 2.3.6
-
Latest EEPPI Build
- Run
./activator
in this project to start the Play console- Optional restrict the memory for java:
./activator -mem 256
- Optional debug mode:
./activator -jvm-debug 9999
- Optional exclude integration tests:
./activator -DtestScope=noVagrantTests
- Optional restrict the memory for java:
- In the play console the following commands are especially useful:
run
to start this project under http://localhost:9000test
to run all testsbuild
to build the project to target/universal/eeppi-1.0.zipcompile
to just compile the code without running anyting
There are some virtual environments you can use to test EEPPI:
- ADRepo Installation: /test/tools/vagrants/ADRepo
- CDAR Installation: /test/tools/vagrants/CDAR
- Redmine/Jira Installation: /test/tools/vagrants/PPT
- Please copy your Jira License to /test/tools/vagrants/PPT before start the environment
There is a vagrant environment containing EEPPI, ADRepo and Jira you can use to test EEPPI fully integrated.:
- /project/vagrant/
- Please copy your Jira License to /test/tools/vagrants/PPT before starting the environment
To start an virtual environment:
- Go to the corresponding directory (e.q. 'cd /test/tools/vagrants/ADRepo' on linux)
- Run 'vagrant up' to start the environment
- This will take some time and needs an internet connection to load the box and the software packages
- After successfull installation and configuration, the environment is ready and the services are reachable using the printed host:port.
- To stop the environment, run 'vagrant halt', to destroy (throw it away and generate it new on next 'vagrant up') run 'vagrant destroy'.
See the README files located near every virtual environment.
In development, play will compile the TypeScript for you. But if you won't to compile it by yourself, do the following:
tsc --target ES5 --out 'htmlMainJSIncludePath' app/assets/scripts/Main.ts
tsc --target ES5 --out 'htmlTestJSIncludePath' public/test/Tests.ts
- Compile tests manual if you didn't start the server app
- Open public/test/index.html using a browser, recommended Firefox
- Node
- See development requirements
- typedoc
- npm install typedoc --global
typedoc --out 'targetDirectory' app/assets/scripts/Main.ts --target ES5