/note-shr

Cross-platform application designed to organize your thoughts on a board with notes

Primary LanguageC#Apache License 2.0Apache-2.0

C# GitHub repo size GitHub Repo Start GitHub GitHub Actions Workflow Build Status GitHub Actions Workflow Test Status

NoteSHR

drawing

A cross-platform application to create own knowledge database, writing own thoughts, ideas and organize information in a creative way.

Development plan

Goals

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

  • Proof of concept
  • Import and export board
  • Beautify app
  • Zoom in/out board
  • Share board with everyone
  • Collaboration API
  • Keep responsiveness and stability for web, desktop and mobile platforms

Implemented features

  • Dragging and resizing notes across the board
  • Adding nodes to note
  • Edit and remove mode for note nodes
  • Importing and exporting board
  • Components in node: Text, List, Check and Image
  • Fully working web and desktop version

Try it out

  • Web version
  • Desktop platforms (Windows, MacOS, Linux). Pick the latest build action from here (Requires .NET 8 runtime to run)
  • Mobile platforms (Android, iOS) not ready yet

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-tools

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