- Fork this repository to your own account
- Make your changes and verify that tests pass (
./gradlew check
) - Run
diktat
static analyzer withdiktatFix
gradle task ordiktatCheck
task depending on what you want. - Run
detekt
withdetektAll
gradle task - After all tests and analyzers passing commit your work and push to a new branch on your fork
- Submit a pull request
- Participate in the code review process by responding to feedback
- Use
gradlew.bat startMysqlDb
on Windows and./gradlew startMysqlDb
on other platforms for setting up database. Make sure you have Docker installed and active. - Run backend.
It can be run either with
./gradlew save-backend:bootRun
or with Intellij Idea Ultimate plugin from the menuServices
. - Run frontend. It can be run with
./gradlew save-frontend:run
. You can enable hot reload by passing--continuous
flag. - More specific instructions can be found in save-deploy
In order to make Spring Intellij Idea Ultimate plugin work properly, you need to set these active profiles in service's configuration:
SaveApplication | SaveGateway | SaveOrchestrator | SavePreprocessor | SaveSandbox | |
---|---|---|---|---|---|
Mac | mac,dev,secure |
mac,dev |
dev,mac,docker-tcp |
dev,mac |
dev,mac,docker-tcp,secure |
Windows | dev,secure |
dev |
dev,win,docker-tcp |
dev |
dev,win,docker-tcp,secure |
Linux | dev,secure |
dev |
dev,docker-tcp |
dev |
dev,docker-tcp,secure |
In order to run save-orchestrator
on Mac with M1 in order to make it run executions, in addition to save-deploy/README.md
you need to
- manually put all the files from
save-agent-*-distribution.jar
intosave-orchestrator/build/resources/main
as well assave-*-linuxX64.kexe
(temporary workaround) - run
docker-mac-settings.sh
script (fromsave-deploy
folder) in order to let docker be available via TCP Also checksave-deploy/README.md
for extra information