Seadistamine

Ehita HolyArrs lähtekoodist ja ava see brauseris pordil 6262.

Enne alustamist

• Go, versioonis, mille nimetab go.mod.
• Node 24 ja npm.
• Terminal repo juurkaustas.

C kompilaatorit sul vaja ei ole. Ehitused kasutavad CGO_ENABLED=0.

Ehita ja käivita

1. Paigalda veebirakenduse paketid:

   npm --prefix app/frontend ci

2. Ehita veebirakendus:

   npm --prefix app/frontend run build

   Näed, kuidas ehitus lõpeb ja app/frontend/dist täitub failidega.

3. Ehita programm:

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

4. Käivita see oma seadete kaustaga:

   ./bin/holyarrs -config ./config

5. Ava http://localhost:6262.

   Näed esimese käivituse viisardit. Tee omaniku konto.

Caution

Programm sisaldab kausta app/frontend/dist. Pärast veebirakenduse muutmist ehita veebirakendus enne programmi uuesti, muidu saad vanad lehed.

-config võtab kausta kohalikul kettal ja vaikimisi on see /config. -addr muudab kuulamisaadressi ja vaikimisi on see :6262.

Arenda veebirakendust

Hoia programm käimas. Käivita teises terminalis arendusserver:

npm --prefix app/frontend run dev

Arendusserver laeb salvestamisel uuesti ja saadab API päringud käimasolevale programmile. Näed oma muudatust brauseris 2 sekundi jooksul.

Valikud

Kasuta Makefile’i

Käsk	Teeb
make ui	Paigaldab veebipaketid ja ehitab veebirakenduse
make build	make ui, seejärel ehitab bin/holyarrs
make test	go test 25 minuti ajapiiriga
make vet	go vet ./...
make docker	Ehitab image’i nimega holyarrs:dev
make e2e	Käivitab otsast otsani testid

Lülita sisse edasi lükatud funktsioon

Mõned funktsioonid on edasi lükatud ja jäävad väljas. Nimeta need muutujas HOLYARRS_FLAGS, komadega eraldatult:

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

Leht peidab väljalülitatud funktsiooni ja selle marsruute ei ole olemas. Kasutajad loevad neist lehelt Edasi lükatud funktsioonid.

Täida meediakogu demoandmetega

Demotööriist täidab seadete kausta demokogumikuga. See töötab ainult peatatud HolyArrsiga ja ainult kaustaga, mille oled laboriks märkinud. Märgi see üks kord:

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

Seejärel lisab seed -config ./config demomeediakogu ja seed -config ./config -reset-demo eemaldab ainult selle, mille ta lisas. Meediakaust peab olema /data/media, kui sa ei anna -force. Arendustööriistad jäävad image’ist välja. Vaata Arendustööriistad.

Kui see ei tööta

Sümptom. Lehed näevad pärast veebirakenduse muutmist vanad välja. Põhjus. Programm teenindab sisse ehitatud versiooni. Lahendus. Käivita veebiehitus, siis Go ehitus, siis käivita programm.

Sümptom. go build ebaõnnestub puuduva app/frontend/dist tõttu. Põhjus. Veebirakendus pole veel ehitatud. Lahendus. Tee esmalt samm 2.

Sümptom. Programm ütleb, et port on kasutuses. Põhjus. Mõni teine HolyArrs või rakendus hoiab porti 6262. Lahendus. Anna teine aadress: ./bin/holyarrs -config ./config -addr :6263.

Asjatundjale

Edasi lükatud lülitid

Lüliti	Funktsioon
row_title_stats	Explore ridade statistika omanikule
trakt_lists	Trakti loendid
alert_channels_more	Teavituskanalid peale Discordi ja e-posti
subtitle_sites	Subtiitrite saidid ja subtiitrite otsing
emby_signin	Embyga sisselogimine
go_back	Sammud eelmisele versioonile tagasi minemiseks

Uue lisamiseks registreeri selle nimi käsuga startup.RegisterFeature ja kontrolli startup.FeatureOn enne selle marsruutide registreerimist. Nimed asuvad kaustas app/backend/internal/core/startup (feature.go).

Arendustööriistad

Tööriist	Käsk	Teeb
Demo	go run ./app/backend/tools/demo <command> -config DIR	Töötab peatatud seadete kaustaga. Käsud: inspect (arvud), fingerprint, query "SELECT ..." (ainult lugemine), doctor, seed, showcase
Võlts subtiitrisait	go run ./app/backend/tools/fakesubs	Teenindab testide jaoks võltssubtiitrisaite aadressil 127.0.0.1:18727. -addr liigutab seda; -accounts-addr lisab kontosaitide võltsid
Marsruutide loend	go run ./app/backend/tools/apidoc	Kirjutab uuesti lehe API marsruudid

Ehita image

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

Image algab FROM scratch ja sisaldab programmi, CA sertifikaate ja litsentse. See käivitab -config /config -addr :6262.

Seotud lehed

• Panustamine
• Testimine
• Moodulid