https://github.com/floriank/hochfuenf
An attempt to make a small application that allows sending groups of people kudos/high fives/etc. internally
https://github.com/floriank/hochfuenf
Last synced: 4 months ago
JSON representation
An attempt to make a small application that allows sending groups of people kudos/high fives/etc. internally
- Host: GitHub
- URL: https://github.com/floriank/hochfuenf
- Owner: floriank
- License: mit
- Created: 2024-01-07T11:57:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-07T19:01:35.000Z (over 1 year ago)
- Last Synced: 2025-02-27T18:44:24.976Z (4 months ago)
- Language: Elixir
- Size: 4.83 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hochfuenf
This is a small application that aims to provide a FOSS alternative to tools
like [15Five](https://15five.com). It's also a way for me to learn and reason
around authentication with common IDPs (such as [Okta](https://okta.com),
[OneLogin](https://onelogin.com), etc.) in an Elixir context.
Ultimately, this should be provide an easy way for groups of people to tell
each other that they did good work and are appreciated, in a manner that is
transparent and traceable.
## Supported Authentication providers
* [Auth0](https://auth0.com)
See [PROVIDERS.md](./PROVIDERS.md) to see additional setup instructions for SSO.
## Getting started with development
This project is a [Phoenix Project, using Elixir](https://phoenixframework.org).
You can run it locally with a PostgreSQL database or you can run it with the
dev setup included.
Regardless of which option you choose, you probably want to run
```shell
# if you use direnv
$ cp .envrc.example .envrc
# if you use dotenv
$ cp .env.example .env
```
just to make sure you have the env variables set locally (the `.env` file gets used
in the `docker` setup.
### Docker setup [recommended]
#### Requirements
- `docker`
- `docker compose`
Run `make` and follow the instructions. For a quick setup, run `make clean setup`, followed
by `make up`.
### Locally
To start your Phoenix server:
* Run `mix setup` to install and setup dependencies
* Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).
#### Learn more about Phoenix and Elixir
* Official website: https://www.phoenixframework.org/
* Guides: https://hexdocs.pm/phoenix/overview.html
* Docs: https://hexdocs.pm/phoenix
* Forum: https://elixirforum.com/c/phoenix-forum
* Source: https://github.com/phoenixframework/phoenix