Kotiseuranta – Ohje

Appearance

Kehitysympäristö ​

Tämä ohje on sovelluksen kehittäjille. Sovellus koostuu Vue 3- ja TypeScript-frontendista, PHP REST API -backendista, MariaDB-tietokannasta ja VitePressillä toteutetusta ohjesivustosta.

Vaatimukset ​

  • Node.js 22+ ja npm
  • PHP 8.2+
  • Composer 2
  • olemassa oleva, projektia varten määritetty MariaDB-tietokanta ja käyttäjä

Asennus ​

Asenna riippuvuudet projektin juuresta:

bash
npm install
cd frontend
npm install
cd ../backend
composer install

Kopioi projektin juuressa .env.example tiedostoksi .env ja täydennä tietokantayhteyden asetukset. Backend lukee tämän tiedoston projektin juuresta. Käytä sovellukselle tarkoitettua tietokantakäyttäjää; salasanoja ei tallenneta versionhallintaan.

bash
cp .env.example .env

Tiedostossa määritetään DB_HOST, DB_PORT, DB_NAME, DB_USER ja DB_PASSWORD. Kirjautumistunnuksia ei määritetä .env-tiedostossa, vaan ne tallennetaan tietokantaan.

Tarkista migraatioiden tila ja suorita puuttuvat migraatiot backend-hakemistossa:

bash
cd backend
composer run migrate-status
composer run migrate

Luo migraatioiden ajamisen jälkeen ensimmäinen käyttäjä backend-hakemistossa:

bash
composer user:create -- asukas

Komento kysyy salasanan kahdesti. Salasana ei näy sitä kirjoitettaessa, kun komento ajetaan sitä tukevassa terminaalissa. Salasanassa pitää olla vähintään 12 merkkiä, ja käyttäjätunnus saa olla enintään 100 merkkiä. Käyttäjätunnuksen täytyy olla yksilöllinen.

Uusia käyttäjiä luodaan samalla komennolla eri käyttäjätunnuksella. Sovelluksessa ei ole käyttäjähallintanäkymää eikä toimintoa salasanan vaihtamiseen tai unohtuneen salasanan palauttamiseen.

Kehityspalvelimet ​

Käynnistä backend, frontend ja tarvittaessa ohjesivusto omissa terminaaleissaan projektin juuresta:

bash
cd backend
composer run serve
bash
cd frontend
npm run dev
bash
npm run docs:dev

Frontend avautuu osoitteessa http://localhost:5173. Backend kuuntelee osoitteessa http://localhost:8081, ja frontendin Vite-kehityspalvelin välittää sille /api- ja /uploads-pyynnöt.

Ohjesivuston VitePress-palvelin ilmoittaa oman osoitteensa käynnistyessään. Tuotantoon rakennetussa sovelluksessa käyttöohje julkaistaan /ohje/-polkuun.

Tarkistukset ​

Aja muutosten jälkeen relevantit tarkistukset:

bash
cd backend
composer test
cd ../frontend
npm run typecheck
npm run build
cd ..
npm run docs:build

Frontendin npm run build suorittaa myös TypeScript-tarkistuksen. Erillinen npm run typecheck on mukana, jotta tyyppivirheet voi tarkistaa ilman tuotantobuildia.

Tarkista lopuksi myös git status ja git diff. Projektin tarkemmat työskentelyohjeet ovat repositoryn AGENTS.md-tiedostossa.