DEVELOPMENT ENVIRONMENT

~liljamo/tixe

7741a367a1eb323f43d7945f83a34cbc5e5a2198 — Jonni Liljamo 11 months ago fd89e55
docs: update README
1 files changed, 10 insertions(+), 6 deletions(-)

M README.md
M README.md => README.md +10 -6
@@ 1,6 1,11 @@
# tixë
Bookmarking / link organizing application.

Disclaimer: Not feature complete, can not truly recommend using
(read: deploying, since no hosted option is available currently) right now.\
But, if you'd like to try it out, theres a demo at [tixe.demo.liljamo.dev](https://tixe.demo.liljamo.dev/),
be sure to read the disclaimer at the top.

## Installation and configuration
An example docker compose file is provided.



@@ 11,6 16,11 @@ Todo... Provide some docs here, and examples. Maybe even try with other services
as OIDC providers, and give generic guides for those. Though that might be for
the man page (man.src.quest).

## Faq
### What, only OIDC?
Yes, that was something I wanted to learn about, so that's what I did.\
I might explore native/internal users at some point, but no promises.

## Todo / Ideas
 * Larger "notes" / "description" section for links, explaining the content
 * Configurable OIDC group that the user has to be in, in order to use the service.


@@ 19,9 29,3 @@ the man page (man.src.quest).
 * A small bit of JS, that would let animations finish even if the user is no longer interacting with the thing.
   * e.g. no longer hovering it.
 * Prolly make the pen animations last longer than the scribble, so the pen can have time to rotate as needed, etc.

## Dev
### Tailwind
```bash
tailwindcss -i input.css -o ./static/styles.css --watch
```