Sąranka

Sukompiliuok HolyArrs iš šaltinio kodo ir atidaryk jį naršyklėje per portą 6262.

Prieš pradedant

• Go tos versijos, kurią nurodo go.mod.
• Node 24 ir npm.
• Terminalas repo šaknyje.

C kompiliatoriaus nereikia. Build naudoja CGO_ENABLED=0.

Sukompiliuok ir paleisk

1. Įdiek žiniatinklio programos paketus:

   npm --prefix app/frontend ci

2. Sukompiliuok žiniatinklio programą:

   npm --prefix app/frontend run build

   Turėtum pamatyti, kad build baigiasi, o app/frontend/dist prisipildo failų.

3. Sukompiliuok programą:

   go build -o bin/holyarrs ./app/backend/cmd/holyarrs

4. Paleisk ją su savo konfigūracijos aplanku:

   ./bin/holyarrs -config ./config

5. Atidaryk http://localhost:6262.

   Turėtum pamatyti pirmo paleidimo vedlį. Susikurk savininko paskyrą.

Caution

Programa į save įdeda app/frontend/dist. Po žiniatinklio programos pakeitimo prieš programą dar kartą sukompiliuok žiniatinklio programą, kitaip gausi senus puslapius.

-config priima aplanką vietiniame diske, numatytasis yra /config. -addr keičia klausymo adresą, numatytasis yra :6262.

Dirbk su žiniatinklio programa

Palik programą veikti. Antrame terminale paleisk dev serverį:

npm --prefix app/frontend run dev

Dev serveris persikrauna kiekvieną kartą išsaugojus ir siunčia API kreipinius veikiančiai programai. Savo pakeitimą naršyklėje turėtum pamatyti per 2 s.

Pasirinkimai

Naudok Makefile

Komanda	Ką daro
make ui	Įdiegia žiniatinklio paketus ir sukompiliuoja žiniatinklio programą
make build	make ui, paskui sukompiliuoja bin/holyarrs
make test	go test su 25 min limitu
make vet	go vet ./...
make docker	Sukompiliuoja image kaip holyarrs:dev
make e2e	Paleidžia end-to-end testus

Įjunk atidėtą funkciją

Kai kurios funkcijos atidėtos ir lieka išjungtos. Įrašyk jų pavadinimus į HOLYARRS_FLAGS, atskirtus kableliais:

HOLYARRS_FLAGS=subtitle_sites,ai_apps ./bin/holyarrs -config ./config

Puslapiai paslepia išjungtą funkciją, o jos maršrutų nėra. Naudotojai apie jas skaito atidėtų funkcijų puslapyje.

Užpildyk Biblioteką demo duomenimis

Demo įrankis užpildo konfigūracijos aplanką demo kolekcija. Jis veikia tik su sustabdyta HolyArrs ir tik su aplanku, kurį pažymėjai kaip lab. Pažymėk jį vieną kartą:

go run ./app/backend/tools/demo seed -config ./config -init-lab

Po to seed -config ./config prideda demo biblioteką, o seed -config ./config -reset-demo pašalina tik tai, ką pridėjo. Medijos aplankas turi būti /data/media, nebent perduodi -force. Dev įrankių image nėra. Žiūrėk dev įrankius.

Jei neveikia

Požymis. Pakeitus žiniatinklio programą, puslapiai atrodo seni. Priežastis. Programa aptarnauja build, kurį į save įdėjo. Sprendimas. Paleisk žiniatinklio build, paskui Go build, paskui paleisk programą.

Požymis. go build nepavyksta dėl trūkstamo app/frontend/dist. Priežastis. Žiniatinklio programa dar nesukompiliuota. Sprendimas. Pirmiausia atlik 2 žingsnį.

Požymis. Programa sako, kad portas užimtas. Priežastis. Kita HolyArrs ar programa užėmė 6262. Sprendimas. Perduok kitą adresą: ./bin/holyarrs -config ./config -addr :6263.

Pažengusiems

Atidėtų funkcijų jungikliai

Jungiklis	Funkcija
row_title_stats	Explore eilučių statistika savininkui
trakt_lists	Trakt sąrašai
alert_channels_more	Pranešimų kanalai be Discord ir el. pašto
subtitle_sites	Subtitrų svetainės ir subtitrų paieška
emby_signin	Prisijungimas per Emby
go_back	Žingsniai grįžti prie ankstesnės versijos

Norint pridėti jungiklį, užregistruok jo pavadinimą per startup.RegisterFeature ir prieš registruojant jo maršrutus patikrink startup.FeatureOn. Pavadinimai yra app/backend/internal/core/startup (feature.go).

Dev įrankiai

Įrankis	Komanda	Ką daro
Demo	go run ./app/backend/tools/demo <command> -config DIR	Veikia su sustabdytu konfigūracijos aplanku. Komandos: inspect (skaičiai), fingerprint, query "SELECT ..." (tik skaitymui), doctor, seed, showcase
Netikra subtitrų svetainė	go run ./app/backend/tools/fakesubs	Testams aptarnauja netikras subtitrų svetaines adresu 127.0.0.1:18727. -addr jį perkelia, -accounts-addr prideda paskyrų svetainių netikrus variantus
Maršrutų sąrašas	go run ./app/backend/tools/apidoc	Perrašo API maršrutus

Sukompiliuok image

docker build --file deploy/Dockerfile --tag holyarrs:dev .
docker run -p 6262:6262 -v ./config:/config holyarrs:dev

Image prasideda nuo FROM scratch ir laiko programą, CA sertifikatus ir licencijas. Jis vykdo -config /config -addr :6262.

Susiję puslapiai

• Prisidėjimas
• Testavimas
• Moduliai