Első lépések
Előfeltételek
Szekció neve “Előfeltételek”A fejlesztéshez az alábbiak szükségesek:
- Bun v1.0+ — runtime és csomagkezelő
- Node.js v20+ — a webalkalmazáshoz szükséges
- Docker és Docker Compose — PostgreSQL-hez
- Git v2.30+
Telepítés
Szekció neve “Telepítés”1. Klónozás
Szekció neve “1. Klónozás”git clone https://github.com/ElyOS-webOS/elyos-core.gitcd elyos-core2. Függőségek
Szekció neve “2. Függőségek”bun install3. Környezeti változók
Szekció neve “3. Környezeti változók”cp .env.example .envAz ElyOS Varlock-ot használ a typesafe env kezeléshez. A .env fájlban csak a bootstrap credentials szükséges — minden más secret az Infisical-ból érkezik indításkor.
Részletes dokumentáció: Környezeti változók →
Infisical hozzáféréssel (ajánlott):
INFISICAL_CLIENT_ID=machine-identity-client-idINFISICAL_CLIENT_SECRET=machine-identity-client-secretAz Infisical hozzáférés igényléséhez fordulj a csapat rendszergazdájához. A Machine Identity credentials az Infisical dashboard-on a projekt beállításainál érhető el.
Infisical nélkül (lokális fallback mód):
Ha nincs Infisical hozzáférésed vagy offline dolgozol, állítsd be a VARLOCK_FALLBACK=local értéket, és add meg az összes szükséges változót közvetlenül a .env-ben:
VARLOCK_FALLBACK=localNODE_ENV=developmentDATABASE_URL=postgresql://elyos:elyos123@localhost:5432/elyosBETTER_AUTH_SECRET=generalt-veletlen-titokBETTER_AUTH_URL=http://localhost:3000ORIGIN=http://localhost:51734. Adatbázis indítása
Szekció neve “4. Adatbázis indítása”bun docker:db # Csak PostgreSQL konténerbun db:init # Migrációk + seed adatokMit csinálnak ezek a parancsok:
docker:db— elindítja a PostgreSQL konténert Docker-bendb:init— teljes adatbázis inicializálás (generálás + migrációk + seed)
Részletek: Scripts referencia →
5. Fejlesztői szerver
Szekció neve “5. Fejlesztői szerver”bun app:devAz alkalmazás elérhető: http://localhost:5173
Mit csinál: Elindítja a SvelteKit dev szervert lokális .env fájllal (Varlock nélkül).
Részletek: Scripts referencia →
Alapértelmezett admin fiók
Szekció neve “Alapértelmezett admin fiók”Seed után az első felhasználó kap admin jogosultságot. Az e-mail cím az ADMIN_USER_EMAIL env változóból olvasódik.
ADMIN_USER_EMAIL=admin@example.com| Mező | Érték |
|---|---|
az ADMIN_USER_EMAIL értéke (vagy a seed alapértelmezés) | |
| Jelszó | Admin1234! |
Docker-alapú futtatás
Szekció neve “Docker-alapú futtatás”A teljes stack (ElyOS + PostgreSQL) Docker Compose-zal is indítható:
bun docker:upEbben az esetben a Varlock a konténer indításakor fut (varlock run -- node server.js), és az Infisical-ból tölti be a secreteket. A .env fájlban csak a bootstrap credentials szükséges.
Részletek: Scripts referencia → Docker
Hasznos parancsok
Szekció neve “Hasznos parancsok”Teljes lista: Scripts referencia →
# Fejlesztésbun app:dev # Dev szerverbun app:build # Éles buildbun app:check # Típusellenőrzés (svelte-check + tsc)
# Adatbázisbun db:generate # Migrációk generálása sémaváltozásokbólbun db:migrate # Függőben lévő migrációk futtatásabun db:seed # Seed adatok betöltésebun db:reset # Adatbázis visszaállításabun db:studio # Drizzle Studio megnyitása
# Dockerbun docker:db # Csak PostgreSQL indításabun docker:up # Teljes stack (ElyOS + DB)bun docker:down # Leállításbun docker:logs # Naplók követése
# Tesztelés (apps/web könyvtárból)bun test # Összes teszt egyszerbun test:pbt # Csak property-based tesztek
# Kódminőség (apps/web könyvtárból)bun lint # Prettier + ESLint ellenőrzésbun format # Automatikus formázásProjekt megnyitása
Szekció neve “Projekt megnyitása”A monorepo gyökerét nyisd meg az IDE-ben. A fő fejlesztési terület az apps/web/src/ mappa.
elyos-core/├── apps/web/src/ ← itt dolgozol leggyakrabban├── apps/web/.env.schema ← env változók sémája (Varlock)├── packages/database/ ← séma és migrációk└── .env ← bootstrap credentials (lokálisan)