Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oxisto/okr2go
okr2go (as in to go) is a simple tracker for your Objective and Key Results (OKR) that you can use locally just using a Markdown file and thus is available to go.
https://github.com/oxisto/okr2go
golang objectives-and-key-results okr svelte sveltekit team-management tracker typescript
Last synced: 3 months ago
JSON representation
okr2go (as in to go) is a simple tracker for your Objective and Key Results (OKR) that you can use locally just using a Markdown file and thus is available to go.
- Host: GitHub
- URL: https://github.com/oxisto/okr2go
- Owner: oxisto
- License: apache-2.0
- Archived: true
- Created: 2019-07-31T15:51:25.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-04-09T15:58:14.000Z (about 1 year ago)
- Last Synced: 2024-01-24T00:44:39.843Z (5 months ago)
- Topics: golang, objectives-and-key-results, okr, svelte, sveltekit, team-management, tracker, typescript
- Language: Go
- Homepage:
- Size: 1.06 MB
- Stars: 49
- Watchers: 3
- Forks: 9
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Lists
- awesome-okr - okr2go
README
# okr2go
[](https://github.com/oxisto/okr2go/actions)
[](https://pkg.go.dev/github.com/oxisto/okr2go)
[](https://github.com/oxisto/okr2go/releases)
[](https://github.com/oxisto/okr2go/blob/main/LICENSE)
okr2go (as in *to go*) is a simple tracker for your Objective and Key Results (OKR) that you can use locally just using a Markdown file and thus is available *to go*.
Ideally, this Markdown file is stored in a git repository, if you want to synchronize it with others. It also includes a simple React-based web frontend to view (and in the future, edit) your objectives.
## Use a Release
Fetch a binary from the latest [GitHub release](https://github.com/oxisto/okr2go/releases) corresponding to your system architecture and start it using `./okr2go`. A browser window with the web ui should open automatically.
Alternativly, a prepared [Docker image](https://github.com/users/oxisto/packages/container/package/okr2go) can be used. In this case the markdown file needs to be mounted into the container.
```bash
docker run -v $(PWD)/example.md:/example.md -p 4300:4300 ghcr.io/oxisto/okr2go
```
## Build from Source
okr2go requires Go >= 1.16 and yarn installed.
### Install Go
On Linux, follow the instructions at https://golang.org/doc/install or an instruction related to your distribution.
On macOS, use `brew` to install Go:
```bash
brew install go
```
### Install yarn
On Debian/Ubuntu, the latest yarn version can be installed from the following ppa:
```bash
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
sudo apt-get update && sudo apt-get install yarn
```
On macOS, use `brew` to install yarn:
```bash
brew install yarn
```
### Run build script
Run the included build script to install all dependencies (React and Go) and build an executable with the packed web frontend. This will also run `go install`, so that your system-specific executable is available globally, if you have the `go/bin` directory in your path.
```bash
./build.sh
```