Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/BurningOKR/BurningOKR
Burning OKR
https://github.com/BurningOKR/BurningOKR
Last synced: 3 months ago
JSON representation
Burning OKR
- Host: GitHub
- URL: https://github.com/BurningOKR/BurningOKR
- Owner: BurningOKR
- License: apache-2.0
- Created: 2020-01-22T13:20:22.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-06T12:24:30.000Z (5 months ago)
- Last Synced: 2024-02-07T14:05:22.951Z (5 months ago)
- Language: Java
- Size: 6.65 MB
- Stars: 130
- Watchers: 19
- Forks: 44
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Lists
- awesome-okr - BurningOkr
README
# 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](/docker/docker-compose-prod.yml) file
2. Download [backend.env.sample](/docker/backend.env.sample) file and **rename** it to backend.env
3. Download [postgres.env.sample](/docker/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](/docs/development.md).
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](/docs/development.md).
## 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!
## Contact
You can write an [E-Mail](mailto:[email protected]) or mention our Twitter account [@BurningOKR](https://twitter.com/BurningOkr).
## License
BurningOKR was initially developed as part of a training project at [BROCKHAUS AG](http://brockhaus-ag.de) 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](LICENSE.txt)