MCPcopy Index your code
hub / github.com/BurningOKR/BurningOKR

github.com/BurningOKR/BurningOKR @2.0.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release 2.0.0 ↗ · + Follow
3,911 symbols 11,414 edges 780 files 139 documented · 4%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Burning OKR

BurningOKR

Burning OKR is our vision to help consistently establish focus and alignment around company goals and embed transparency into the corporate culture.

BurningOKR has been developed as a web application with an Angular Frontend and Java Spring Boot Backend. As a database, Postgres SQL is used.

Installation

When you have Docker and Docker-Compose installed you can proceed with the next steps, otherwise please install Docker and Docker-Compose first.
You can use our docker-compose file for easy use and compatibility!

  1. Download the docker-compose-prod.yml file
  2. Download backend.env.sample file and rename it to backend.env
  3. Download postgres.env.sample file and rename it to postgres.env
  4. Now fill in your configurations in the two downloaded .env-files
  5. Hint: When you don't want to use Azure or a SMTP-Mailserver just comment these parts in the .env-files out and they won't be used. For more information read the development docs.
  6. After that you are good to go and you can run docker compose -f docker-compose-prod.yml up in the directory where the previously downloaded files are saved. Hint: When you want to reuse the console window add a -d to the compose command to run in detached mode.

Development

When you want to contribute to BurningOKR or develop something for yourself please refer to the development readme.

FAQ

  • I have BurningOKR running in a Tomcat, should i migrate to Docker?
    Yes you should. We will only support the docker images. When you want to use Tomcat you can do so, but we will offer no support.

  • I get some errors with npm install (python2, node-sass, node-gyp):
    Use the LTS version of node, not the current! https://nodejs.org/en/download/

Contact

You can write an E-Mail or mention our Twitter account @BurningOKR.

License

BurningOKR was initially developed as part of a training project at BROCKHAUS AG in Lünen.

Only an Open Source solution can unfold its true potential. That's why we released it on GitHub as an open-source project under the Apache 2.0 license.

See LICENSE.txt

Extension points exported contracts — how you extend this code

Fetchable (Interface)
(no doc) [7 implementers]
frontend/src/app/shared/decorators/fetchable.decorator.ts
DataMapper (Interface)
(no doc) [23 implementers]
backend/burning-okr/burning-okr-app/src/main/java/org/burningokr/mapper/interfaces/DataMapper.java
TaskBoardObject (Interface)
(no doc) [5 implementers]
frontend/src/app/shared/model/ui/taskboard/task-board-object.ts
Trackable (Interface)
(no doc) [4 implementers]
backend/burning-okr/burning-okr-model/src/main/java/org/burningokr/model/activity/Trackable.java
IUserService (Interface)
(no doc) [4 implementers]
frontend/src/app/shared/services/helper/i-user-service.ts
OkrParentUnit (Interface)
(no doc) [3 implementers]
backend/burning-okr/burning-okr-model/src/main/java/org/burningokr/model/okrUnits/OkrParentUnit.java
ComponentCanDeactivate (Interface)
(no doc) [3 implementers]
frontend/src/app/core/auth/guards/can-deactivate.guard.ts
RowBuilderService (Interface)
(no doc) [2 implementers]
backend/burning-okr/burning-okr-logic/src/main/java/org/burningokr/service/excel/RowBuilderService.java

Core symbols most depended-on inside this repo

n
called by 539
frontend/src/klaro.js
getId
called by 409
backend/burning-okr/burning-okr-model/src/main/java/org/burningokr/model/activity/Trackable.java
get
called by 318
frontend/src/typings.d.ts
mapEntityToDto
called by 188
backend/burning-okr/burning-okr-app/src/main/java/org/burningokr/mapper/interfaces/DataMapper.java
getName
called by 183
backend/burning-okr/burning-okr-model/src/main/java/org/burningokr/model/activity/Trackable.java
mapDtoToEntity
called by 175
backend/burning-okr/burning-okr-app/src/main/java/org/burningokr/mapper/interfaces/DataMapper.java
findById
called by 164
backend/burning-okr/burning-okr-logic/src/main/java/org/burningokr/service/okr/NoteService.java
findByIdOrThrow
called by 155
backend/burning-okr/burning-okr-data/src/main/java/org/burningokr/repositories/ExtendedRepository.java

Shape

Method 2,753
Class 878
Function 146
Interface 110
Enum 24

Languages

Java50%
TypeScript50%

Modules by API surface

frontend/src/klaro.js108 symbols
backend/burning-okr/burning-okr-logic/src/test/java/org/burningokr/service/okr/ObjectiveServiceTest.java35 symbols
backend/burning-okr/burning-okr-app/src/test/java/org/burningokr/mapper/okr/ObjectiveMapperTest.java34 symbols
backend/burning-okr/burning-okr-app/src/test/java/org/burningokr/mapper/okr/OkrTopicDraftMapperTest.java32 symbols
frontend/src/typings.d.ts31 symbols
backend/burning-okr/burning-okr-app/src/test/java/org/burningokr/mapper/okr/KeyResultMapperTest.java31 symbols
backend/burning-okr/burning-okr-app/src/test/java/org/burningokr/mapper/okr/OkrTopicDescriptionMapperTest.java28 symbols
backend/burning-okr/burning-okr-app/src/test/java/org/burningokr/mapper/cycle/CycleMapperTest.java27 symbols
frontend/src/app/topic-drafts/topic-draft-action-button-component/topic-draft-action-button.component.ts26 symbols
backend/burning-okr/burning-okr-app/src/test/java/org/burningokr/mapper/okrUnit/OkrDepartmentMapperTest.java25 symbols
backend/burning-okr/burning-okr-logic/src/test/java/org/burningokr/service/excel/ObjectiveRowBuilderServiceTest.java24 symbols
frontend/src/app/okrview/okr-child-unit/department/department-tab-taskboard/department-tab-taskboard.component.ts23 symbols

Datastores touched

okrDatabase · 1 repos
okr-draftDatabase · 1 repos

For agents

$ claude mcp add BurningOKR \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page