1
0
mirror of https://github.com/hrfee/jfa-go.git synced 2024-12-29 12:30:11 +00:00

Compare commits

...

3 Commits

Author SHA1 Message Date
461efa7f60
oops 2021-01-11 16:10:04 +00:00
1321f8df50
mention contributing.md 2021-01-11 16:09:30 +00:00
a081f3a799
add contribution notes 2021-01-11 16:07:49 +00:00
2 changed files with 20 additions and 3 deletions

12
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,12 @@
#### Translation
Currently only the account creation form can be translated. Strings are defined in `lang/form/<country-code>.json` (country code as in `en-us`, `fr-fr`, e.g). You can see the existing ones [here](https://github.com/hrfee/jfa-go/tree/main/lang/form).
Make sure to define `name` in the `meta` section, and you can optionally add an `author` value there as well. If you can, make a pull request with your new file. If not, email me or create an issue.
#### Code
I use 4 spaces for indentation. Go should ideally be formatted with `goimports` and/or `gofmt`. I don't use a formatter on typescript, so don't worry about that.
If you need to test your changes:
* `make debug` will build everything, and include sourcemaps for typescript. This should be the first thing you run.
* `make compile` compiles go into `build/jfa-go`.
* `make ts-debug` will compile typescript w/ sourcemaps into `build/data/web/js`.
* `make copy` will copy css, html, language and static files into `build/data`.

View File

@ -1,5 +1,7 @@
# ![jfa-go](images/banner.svg) ![jfa-go](images/banner.svg)
[![Build Status](https://drone.hrfee.pw/api/badges/hrfee/jfa-go/status.svg?ref=refs/heads/main)](https://drone.hrfee.pw/hrfee/jfa-go)
[![Docker Hub](https://img.shields.io/docker/pulls/hrfee/jfa-go?label=docker)](https://hub.docker.com/r/hrfee/jfa-go)
---
jfa-go is a user management app for [Jellyfin](https://github.com/jellyfin/jellyfin) (and now [Emby](https://emby.media/)) that provides invite-based account creation as well as other features that make one's instance much easier to manage. jfa-go is a user management app for [Jellyfin](https://github.com/jellyfin/jellyfin) (and now [Emby](https://emby.media/)) that provides invite-based account creation as well as other features that make one's instance much easier to manage.
I chose to rewrite the python [jellyfin-accounts](https://github.com/hrfee/jellyfin-accounts) in Go mainly as a learning experience, but also to slightly improve speeds and efficiency. I chose to rewrite the python [jellyfin-accounts](https://github.com/hrfee/jellyfin-accounts) in Go mainly as a learning experience, but also to slightly improve speeds and efficiency.
@ -22,7 +24,7 @@ I chose to rewrite the python [jellyfin-accounts](https://github.com/hrfee/jelly
* Specify contact and help messages to appear in emails and pages * Specify contact and help messages to appear in emails and pages
* Light and dark themes available * Light and dark themes available
## Interface #### Interface
<p align="center"> <p align="center">
<img src="images/demo.gif" width="100%"></img> <img src="images/demo.gif" width="100%"></img>
</p> </p>
@ -86,3 +88,6 @@ If you're switching from jellyfin-accounts, copy your existing `~/.jf-accounts`
* `~/Library/Application Support/jfa-go` on macOS. * `~/Library/Application Support/jfa-go` on macOS.
(or specify config/data path with `-config/-data` respectively.) (or specify config/data path with `-config/-data` respectively.)
#### Contributing
See [CONTRIBUTING.md](https://github.com/hrfee/jfa-go/blob/main/CONTRIBUTING.md).