Skip to content

Latest commit

 

History

History
80 lines (50 loc) · 2.71 KB

README.md

File metadata and controls

80 lines (50 loc) · 2.71 KB
Raw

DrawTogether.NET

A collaborative browser-based drawing program written in .NET.

Please see REQUIREMENTS for more information.

Running Locally

First things first, you will need to launch the dependencies for DrawTogether.NET - make sure you have docker installed locally:

Windows

start-dependencies.cmd

Linux

start-dependencies.sh

This will launch, among other things, a prebuilt SQL Server 2022 instance that has the correct default connection string and DrawTogether database required by DrawTogether.NET.

Entity Framework Core Migrations

If you need to apply a change to the database model, by default this project uses the SQL Server 2022 launched in the step above. To apply migrations, change your directory to the DrawTogether project:

cd ./src/DrawTogether/

And then apply the migrations:

dotnet ef database update

To generate a migration script that you can apply manually (later):

dotnet ef migrations script

MailGun Configuration

DrawTogether.NET can use MailGun to send outbound emails (via FluentEmail.Mailgun) - and the following two secrets need to be configured in order for that sending to work:

cd ./src/DrawTogether/
dotnet user-secrets set "EmailSettings:MailgunDomain" "<mailgun-domain>"
dotnet user-secrets set "EmailSettings:MailgunApiKey" "<mailgun-api-key>"

If these settings are not provided, DrawTogether.NET will simply fall back to not having email available to support ASP.NET Core Identity.

Deployment

Out of the box DrawTogether.NET supports Kubernetes deployments, however, if you want to run it locally you'll need to make sure that you have Nginx Ingress enabled.

This is how to deploy the most recent version of Nginx Ingress on Docker Desktop at the time of writing this:

kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.10.1/deploy/static/provider/cloud/deploy.yaml

Next, you will need to build a local Docker image:

dotnet publish src/DrawTogether/DrawTogether.csproj --os linux --arch x64 -c Release -p:PublishProfile=DefaultContainer

This will tag a local Docker image with the following labels:

  • drawtogether-app:latest
  • drawtogether-app:{VERSION}

Update the k8s-web-service.yaml to use the drawtogether-app:{VERSION} label - if you try to use the drawtogether-app:latest Kubernetes will attempt to pull the latest image from Docker Hub.

Finally, launch everything via the ./k8s/deployAll.cmd - and DrawTogether should be available at http://drawtogether.localdev.me