Skip to content

A multi-platform application to effectively manage notes on a whiteboard.

License

Notifications You must be signed in to change notification settings

MRmlik12/note-shr

Repository files navigation

C# GitHub repo size GitHub GitHub Actions Workflow Status

NoteSHR

drawing

A multi-platform application to effectively manage notes on a whiteboard.

Goals

For more detailed plan of app development please look into TODO board

  • Proof of concept
  • Save file scheme
  • Beautify app
  • Share board with everyone
  • Collaboration API
  • Keep responsiveness and stability for web, desktop and mobile platforms

Try it out

  • Web version
  • Desktop platforms (Windows, MacOS, Linux). Pick the latest build action from here

Build/Run process

To run this project you must install .NET 8 with workloads such as android , iOS and wasm-tools

Install dependencies

$ dotnet restore
# Install workloads
$ dotnet workload install android
$ dotnet workload install iOS
$ dotnet workload install wasm-to

Run project

# Run a Desktop platform 
$ dotnet run --project src/NoteSHR.Desktop
# For iOS platform
$ dotnet run --project src/NoteSHR.iOS
# For Android platform
$ dotnet run --project src/NoteSHR.Android
# For Web platform
$ dotnet run --project src/NoteSHR.Browser

Run tests

Using Bash

$ ./build.sh Test

Using PowerShell

> .\build.ps1 Test

Build

Using Bash

# For desktop platforms
$ ./build.sh --configuration Release
# For iOS platform
$ ./build.sh --configuration Release --allow-ios-build
# For Android platform
$ ./build.sh --configuration Release --allow-android-build

Using PowerShell

# For desktop platforms 
> .\build.ps1 
# For iOS platform
> .\build.ps1 --allow-ios-build
# For Android platform
> .\build.ps1 --allow-android-build

Used libraries