Setup

I-build ang HolyArrs mula sa source at buksan ito sa browser mo sa port 6262.

Bago ka magsimula

• Go, sa bersyong pinangalanan ng go.mod.
• Node 24 at npm.
• Isang terminal sa root ng repo.

Hindi mo kailangan ng C compiler. Gumagamit ang mga build ng CGO_ENABLED=0.

I-build at patakbuhin

1. I-install ang mga package ng web app:

   npm --prefix app/frontend ci

2. I-build ang web app:

   npm --prefix app/frontend run build

   Dapat matapos ang build at mapuno ng mga file ang app/frontend/dist.

3. I-build ang program:

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

4. Patakbuhin ito gamit ang sarili mong config folder:

   ./bin/holyarrs -config ./config

5. Buksan ang http://localhost:6262.

   Dapat makita mo ang wizard sa unang takbo. Gawin ang account ng May-ari.

Caution

Ini-embed ng program ang app/frontend/dist. Pagkatapos magbago sa web app, i-build muli ang web app bago ang program, o luma ang makukuha mong mga page.

Ang -config ay tumatanggap ng folder sa lokal na disk at ang default ay /config. Binabago ng -addr ang address na pinakikinggan at ang default ay :6262.

Magtrabaho sa web app

Hayaang tumatakbo ang program. Sa pangalawang terminal, simulan ang dev server:

npm --prefix app/frontend run dev

Nagre-reload ang dev server kapag nag-save ka at ipinapadala nito ang mga tawag sa API sa tumatakbong program. Dapat makita mo ang edit mo sa browser sa loob ng 2 s.

Mga pagpipilian

Gamitin ang Makefile

Command	Ginagawa
make ui	I-install ang mga web package at i-build ang web app
make build	make ui, tapos i-build ang bin/holyarrs
make test	go test na may 25 min na timeout
make vet	go vet ./...
make docker	I-build ang image bilang holyarrs:dev
make e2e	Patakbuhin ang mga end-to-end test

I-on ang isang tampok na hindi pa bukas

May mga tampok na hindi pa bukas at nananatiling naka-off. Pangalanan ang mga ito sa HOLYARRS_FLAGS, pinaghihiwalay ng kuwit:

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

Itinatago ng mga page ang tampok na naka-off, at wala ang mga route nito. Mababasa ng mga user ang tungkol sa mga ito sa Mga tampok na hindi pa bukas.

Punuin ang Aklatan ng demo data

Pinupuno ng demo tool ang isang config folder ng demo na koleksyon. Gumagana lang ito sa naka-stop na HolyArrs at sa folder na minarkahan mong lab. Markahan ito nang isang beses:

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

Pagkatapos, ang seed -config ./config ay nagdaragdag ng demo na aklatan at ang seed -config ./config -reset-demo ay nag-aalis lang ng idinagdag nito. Dapat /data/media ang media folder maliban kung magpasa ka ng -force. Hindi kasama sa image ang mga dev tool. Tingnan ang Mga dev tool.

Kung hindi gumana

Sintomas. Luma ang itsura ng mga page pagkatapos mong baguhin ang web app. Dahilan. Ang program ay nagseserbisyo ng build na naka-embed dito. Solusyon. Patakbuhin ang web build, tapos ang Go build, tapos simulan ang program.

Sintomas. Nabibigo ang go build dahil kulang ang app/frontend/dist. Dahilan. Hindi pa naka-build ang web app. Solusyon. Patakbuhin muna ang hakbang 2.

Sintomas. Sinasabi ng program na ginagamit na ang port. Dahilan. May ibang HolyArrs o app na may hawak ng 6262. Solusyon. Magpasa ng ibang address: ./bin/holyarrs -config ./config -addr :6263.

Para sa mga eksperto

Mga switch ng tampok na hindi pa bukas

Switch	Tampok
row_title_stats	Mga estadistika ng row sa Explore para sa May-ari
trakt_lists	Mga listahan ng Trakt
alert_channels_more	Mga channel ng alerto bukod sa Discord at email
subtitle_sites	Mga site ng subtitle at paghahanap ng subtitle
emby_signin	Mag-sign in gamit ang Emby
go_back	Mga hakbang para bumalik sa naunang bersyon

Para magdagdag ng isa, i-register ang pangalan nito gamit ang startup.RegisterFeature at suriin ang startup.FeatureOn bago mo i-register ang mga route nito. Nasa app/backend/internal/core/startup (feature.go) ang mga pangalan.

Mga dev tool

Tool	Command	Ginagawa
Demo	go run ./app/backend/tools/demo <command> -config DIR	Gumagana sa naka-stop na config folder. Mga command: inspect (mga bilang), fingerprint, query "SELECT ..." (read-only), doctor, seed, showcase
Pekeng site ng subtitle	go run ./app/backend/tools/fakesubs	Nagseserbisyo ng mga pekeng site ng subtitle para sa mga test sa 127.0.0.1:18727. Inililipat ito ng -addr; nagdaragdag ang -accounts-addr ng mga peke ng account-site
Listahan ng route	go run ./app/backend/tools/apidoc	Isinusulat muli ang Mga API route

I-build ang image

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

Nagsisimula ang image sa FROM scratch at laman nito ang program, mga CA certificate at mga lisensya. Pinapatakbo nito ang -config /config -addr :6262.

Kaugnay

• Contributing
• Testing
• Modules