developer-setup.md

Developer Setup

This repo is a Monorepo. Run helper scripts using npm-scripts.

Prerequisites

• Git
  • Windows: https://git-scm.com/download/win
  • macOS: https://git-scm.com/download/mac
• Node.js - Version 16.13.0
  • Windows: https://github.com/coreybutler/nvm-windows/releases/download/1.1.9/nvm-setup.zip
  • macOS: https://github.com/nvm-sh/nvm#install--update-script
• dotnet SDK - Version 3.1.416
  • Windows: https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/sdk-3.1.416-windows-x64-installer
  • macOS: https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/sdk-3.1.416-macos-x64-installer
• Docker Desktop
  • Windows: https://desktop.docker.com/win/main/amd64/Docker%20Desktop%20Installer.exe
  • macOS: https://desktop.docker.com/mac/main/amd64/Docker.dmg

dotnet tools

dotnet tool install --global dotnet-ef

Installation

• Windows: use Windows PowerShell as Admin
• macOS: use zsh or bash

# clone the repo
git clone https://github.com/timokluser-dev/GBS_MyPerformance.git
cd GBS_MyPerformance
git checkout master

# copy .sample files
cp GBS_MyPerformance/appsettings.Development.sample.json GBS_MyPerformance/appsettings.Development.json
cp GBS_MyPerformance/appsettings.sample.json GBS_MyPerformance/appsettings.json

# activate node version
nvm install $(cat .nvmrc)
nvm use $(cat .nvmrc)

# install dependencies
npm install
npm run clientapp:install
# if failed: cd ./GBS_MyPerformance/ClientApp ; npm install ; cd ../..

# open 'Docker Desktop'
# Windows: make sure that linux containers are selected

# start containers
npm run docker:up

# run migrations
dotnet ef database update -p GBS_MyPerformance

# start visual studio from terminal
npm run win:vs # npm run mac:vs

# install certificates
dotnet dev-certs https --clean
dotnet dev-certs https --trust

Running

The following command starts both, BE & FE.

npm run backend:start

➡️ https://localhost:5001

Developing

When doing changes to the BE & FE.

# start visual studio from terminal
npm run mac:vs
npm run win:vs

# start with auto reload
npm run backend:start-dev

➡️ https://localhost:5001

❔ Questions

➡️ Contact timo.kluser@edu.gbssg.ch