Ovaj odjeljak dokumentacije treba dati detaljne smjernice za instalaciju, konfiguraciju, pokretanje i administraciju aplikacije. Cilj je olakšati postavljanje aplikacije na razvojnom, ispitnom i produkcijskom okruženju.

1. Instalacija

Ovdje treba navesti korake potrebne za instalaciju svih potrebnih komponenti:

• Preduvjeti: Popis potrebnog softvera i njihovih verzija (npr. Node.js 16, Docker 20.10).

• Preuzimanje: Upute za preuzimanje izvornog koda (npr. kloniranje Git repozitorija).

Primjer:

git clone https://github.com/Projekt/primjer.git

cd repo

Instalacija ovisnosti: Upute za instaliranje ovisnosti.

npm install

2. Postavke

Detaljne upute za konfiguraciju aplikacije:

• Konfiguracijske datoteke: Gdje se nalaze (npr. config.json, .env) i što treba prilagoditi.

  • Primjer .env datoteke:

DATABASE_URL=postgres://user:password@localhost:5432/dbname

API_KEY=your_api_key

• Postavke baze podataka: Upute za inicijalizaciju baze podataka, uključujući migracije i postavljanje inicijalnih podataka.

npm run db:migrate

npm run db:seed

3. Pokretanje aplikacije

Upute za pokretanje aplikacije u različitim okruženjima:

• Razvojno okruženje:

npm run dev

• Produkcijsko okruženje:

  • Prevođenje aplikacije:

npm run build

• Pokretanje poslužitelja:

npm start

• Provjera rada: Navesti npr. URL (npr. http://localhost:3000) .

4. Upute za administratore

Smjernice za administratore aplikacije nakon puštanja u pogon:

• Pristup administratorskom sučelju:

  • URL za admin panel (npr. /admin).

  • Početni podaci za prijavu (ako postoje).

• Redovito održavanje:

  • Arhiviranje baze podataka.

  • Pregled logova.

  • Ažuriranje aplikacije (primjer: povlačenje novih verzija iz Git repozitorija i ponovno pokretanje aplikacije).

git pull origin main

npm install

npm run build

npm start

• Rješavanje problema: Kako pristupiti logovima i dijagnosticirati greške (npr. logs/error.log ili docker logs).

---

5. Primjer za Render platformu (Cloud Deploy)

Render je popularna cloud platforma za jednostavno smješanje aplikacija.

• Priprema repozitorija:

  • Osigurajte da vaš projekt ima datoteku render.yaml ili Dockerfile za konfiguraciju deploya.

  • Primjer render.yaml:

services:

- type: web

name: my-web-app

env: node

buildCommand: npm install && npm run build

startCommand: npm start

plan: free

• Postavljanje na Render:

  • Prijavite se na Render.

  • Kreirajte novi Web Service i povežite ga s vašim GitHub repozitorijem.

  • Konfigurirajte postavke (npr. build i start komande).

  • Dodajte environment varijable (npr. DATABASE_URL, API_KEY).

• Pokretanje aplikacije:
  Render će automatski preuzeti repozitorij, instalirati ovisnosti i pokrenuti aplikaciju. Nakon deploya, aplikaciji možete pristupiti putem generiranog URL-a (npr. https://my-web-app.onrender.com).

Opis prisutpa aplikaciji na javnom poslužitelju

Pristup aplikaciji Dokumentirajte postupak i pružite jasne smjernice za korištenje aplikacije na javnom poslužitelju.

• Navedite ograničenja!

• U uputama obuhvatite kako korisnici mogu pristupiti aplikaciji putem internetskog preglednika.

• Priložite korake za pristup administratorskom sučelju ako je primjenjivo.

Predložak temeljen na wiki materijalima projekta Programsko inženjerstvo autora Vlado Sruk, pod licencom CC BY-NC-SA 4.0.