Commit 4f81d53d authored by Jan Smejkal's avatar Jan Smejkal Committed by Juraj Fiala
Browse files

fix: README login and diagrams comment

parent 5d7b27be
Pipeline #123185 waiting for manual action with stage
...@@ -3,35 +3,42 @@ ...@@ -3,35 +3,42 @@
For the PA165 course at MUNI Spring 2022. For the PA165 course at MUNI Spring 2022.
more info here: https://is.muni.cz/auth/el/fi/jaro2022/PA165/seminars.qwarp?prejit=8681242 more info here: https://is.muni.cz/auth/el/fi/jaro2022/PA165/seminars.qwarp?prejit=8681242
## Milestone 1 ## Project assignment
The web application is an archive of missions performed by agents of a secret service.
## Project description It contains data about countries, missions, agents and reports from each agent from each mission.
Secret Archive is a simple information system for managing missions. The data about countries are similar as the CIA World Factbook (google it up).
Each mission targets a country, has some duration, objectives and needs some material resources (explosives, submarines etc.).
Agents have personal data about their codenames, training, language skills, weapon skills etc.
Agents are assigned to a mission for independent periods of time, thus the number of agents assigned to mission may change during its duration.
A report about each assignment and an agent’s performance evaluation is archived.
The application also helps to find available agents that have previous experience with a country and have required skills for a planned mission.
## About project ## About project
Name: Secret Archive
Technologies: Java 17, Spring, Maven, Lombok, TODO Technologies: Java 11, Spring boot, Maven, H2 database.
Developers: Developers:
* Jan Smejkal @xsmejka9 * Jan Smejkal @xsmejka9
* Juraj Fiala @xfiala1 * Juraj Fiala @xfiala1
* Milan Mozolák @xmozolak * Milan Mozolák @xmozolak
* Tomáš Biloš @bilos * Tomáš Biloš @xbilos
### Project assignment text
13\. Secret Service Archive ## How to build & run
To build the project you must have Maven installed.
Make sure you are using Java 11 to build and run the project.
The web application is an archive of missions performed by agents of a secret service. It contains data about countries, missions, agents and reports from each agent from each mission. The data about countries are similar as the CIA World Factbook (google it up). Each mission targets a country, has some duration, objectives and needs some material resources (explosives, submarines etc.). Agents have personal data about their codenames, training, language skills, weapon skills etc. Agents are assigned to a mission for independent periods of time, thus the number of agents assigned to mission may change during its duration. A report about each assignment and an agent’s performance evaluation is archived. The application also helps to find available agents that have previous experience with a country and have required skills for a planned mission. Build: `mvn clean install`
## How to run Run: TBA (currently is implemented only DAO layer)
What to install:
How to run:
Java version: 17
`mvn clean XXX` and so on
## Diagrams ## Diagrams
### Use case diagram The diagrams were made in plantUML available at https://plantuml.com/.
TODO with at least 2 roles
### Class diagram ### Class Diagram
TODO Associations between entities will be shown in a class diagram. [<img src="docs/class.png">]()
### Usecase Diagram
[<img src="docs/useCase.png">]()
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment