system-praktyk-api/README.MD
maxchil 6de23161e9 XD (#100)
XD

MD

Co-authored-by: Michal Bohdanowicz <m.w.bohdanowicz@gmail.com>
2021-01-18 20:30:37 +01:00

1.5 KiB

Uruchomienie

Aby uruchomić środowisko deweloperskie wystarczy

docker build -f ./InternshipSystem.Api/Dockerfile -t internship.api .
docker-compose -f ./.docker/docker-compose.yaml --build --volumes

Opis struktury

Opis struktury projektu

src/

zawiera kod podzielony na 3 projekty

  • Api - Definicja interfejsu wystawianego dla częsci frontendowej
  • Core - Logika biznesowa aplikacji, definicja domeny.
  • Repository - Definicja repozytorium EFCore

test/

Zawiera testy jednostkowe projektu. Przy pisaniu wykorzystano Machine-Specification

.build/

Folder zawierający pliki definiujące CI/CD projektu

.docker/

Folder zawiera pliki docker-compose przeznaczone do uruchamiania środowiska deweloperskiego, stanowiące również dokumentacje zmiennych środowiskowych konfigurujących projekt

CONNECTIONSTRINGS__INTERNSHIPDATABASE: "Host=db.postgres;Port=5432;Database=postgres;Username=postgres;Password=password"
ASPNETCORE_ENVIRONMENT: Development
ASPNETCORE_URLS: http://+:80
SECURITYOPTIONS__SECRET: secret
SECURITYOPTIONS__EXPIRATION: 1440     # 24h in minutes
SECURITYOPTIONS__BASEURL: https://logowanie.pg.edu.pl
SECURITYOPTIONS__TOKENPATH: /oauth2.0/accessToken
SECURITYOPTIONS__PROFILEPATH: /oauth2.0/profile
SECURITYOPTIONS__CLIENTID: PraktykiClientId
SECURITYOPTIONS__REDIRECTURL: https://system-praktyk.net/user/login/check/pg

props/

Folder ze współdzieloną konfiguracją dla grup projektów, np. wersji bibliotek używanych przy pisaniu testów.