From 60ed50c43622e8264d31fb29fc31972aa2942993 Mon Sep 17 00:00:00 2001 From: Michal Bohdanowicz Date: Mon, 18 Jan 2021 20:28:31 +0100 Subject: [PATCH 1/2] MD --- README.MD | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 README.MD diff --git a/README.MD b/README.MD new file mode 100644 index 0000000..67b7857 --- /dev/null +++ b/README.MD @@ -0,0 +1,50 @@ +# Uruchomienie + +Aby uruchomić środowisko deweloperskie wystarczy + +```bash +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 + +```yaml +CONNECTIONSTRINGS__INTERNSHIPDATABASE: "Host=db.postgres;Port=5432;Database=postgres;Username=postgres;Password=password" +ASPNETCORE_ENVIRONMENT: Development +ASPNETCORE_URLS: http://+:80 +SECURITYOPTIONS__SECRET: iewaiwie3aig9wi3chieBai9eephai +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 +FILLER__USE_DEFAULT_DATA: "true" +``` + +## props/ + +Folder ze współdzieloną konfiguracją dla grup projektów, np. wersji bibliotek używanych przy pisaniu testów. -- 2.45.2 From d1880cd2e442a3a4b2d38193b50cf513adedcc8b Mon Sep 17 00:00:00 2001 From: Michal Bohdanowicz Date: Mon, 18 Jan 2021 20:29:36 +0100 Subject: [PATCH 2/2] XD --- README.MD | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.MD b/README.MD index 67b7857..0d09b73 100644 --- a/README.MD +++ b/README.MD @@ -35,14 +35,13 @@ Folder zawiera pliki docker-compose przeznaczone do uruchamiania środowiska dew CONNECTIONSTRINGS__INTERNSHIPDATABASE: "Host=db.postgres;Port=5432;Database=postgres;Username=postgres;Password=password" ASPNETCORE_ENVIRONMENT: Development ASPNETCORE_URLS: http://+:80 -SECURITYOPTIONS__SECRET: iewaiwie3aig9wi3chieBai9eephai +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 -FILLER__USE_DEFAULT_DATA: "true" +SECURITYOPTIONS__REDIRECTURL: https://system-praktyk.net/user/login/check/pg ``` ## props/ -- 2.45.2