Skip to content

Commit

Permalink
chore: Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
philipp-meier committed Sep 8, 2023
1 parent 248ce21 commit 4424771
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@
[![CodeScene Code Health](https://codescene.io/projects/41477/status-badges/code-health)](https://codescene.io/projects)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/philipp-meier/Chrono/blob/main/LICENSE)

A simple self-hostable (business) value centric application to organize and priorize ideas / tasks across multiple teams or projects.
A simple self-hostable (business) value centric application to organize and priorize ideas / tasks across multiple teams
or projects.

This application was inspired by the [staffeng.com](https://staffeng.com/guides/work-on-what-matters/) blog and is a simple tool to keep track of useful ideas that positively impact your project(s) and therefore - _work on what matters_.
This application was inspired by the [staffeng.com](https://staffeng.com/guides/work-on-what-matters/) blog and is a
simple tool to keep track of useful ideas that positively impact your project(s) and therefore - _work on what matters_.

## Current features

Expand All @@ -23,8 +25,9 @@ This application was inspired by the [staffeng.com](https://staffeng.com/guides/
- Multi-user capable with OpenID Connect authentication.
- **Why**-centric for maximizing impact.
- Follows security best-practices.
- Markdown support and syntax highlighting for task descriptions.

## Preview (23th June 2023)
## Preview (8th September 2023)

### Home

Expand All @@ -48,13 +51,15 @@ This application was inspired by the [staffeng.com](https://staffeng.com/guides/

## Getting started

You will need an empty `sqlite3`-database in the `data`-folder of the project. For this you can execute the following command:
You will need an empty `sqlite3`-database in the `data`-folder of the project. For this you can execute the following
command:

```sh
sqlite3 chrono.db "VACUUM;"
```

Besides the database, you also need an OAuth provider like [auth0](https://auth0.com) and configure the `Authority`, `ClientId` and `ClientSecret` in the `appsettings.json` file of the `WebUI` project.
Besides the database, you also need an OAuth provider like [auth0](https://auth0.com) and configure
the `Authority`, `ClientId` and `ClientSecret` in the `appsettings.json` file of the `WebUI` project.

Once that is done, you can run the application with (for example) `dotnet watch` in the `WebUI` folder.

Expand Down
Binary file modified static/List.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/Mobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4424771

Please sign in to comment.