FabInfra-Mirror/borepin
1
0
Fork 0
mirror of https://gitlab.com/fabinfra/fabaccess/borepin.git synced 2025-03-12 14:51:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'update-readme' into 'main'

Browse Source 
Move documentation to official docs platform

See merge request fabinfra/fabaccess/borepin!85
This commit is contained in:
Mario Voigt 2025-02-22 10:48:00 +00:00
commit 2986da785e
1 changed files with 6 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
README.md
View File

@ -1,86 +1,10 @@
Borepin # Borepin
===
# Building Borepin is the client application for using FabAccess. Borepin is written in C# with [Xamarin](https://dotnet.microsoft.com/apps/xamarin) for UI. We use [Prism Libary](https://prismlibrary.com/docs/xamarin-forms/Getting-Started.html) for MVVM and navigation managment.
## On Windows # Download
1. Install Visual Studio 2019
[download Visual Studio](https://visualstudio.microsoft.com/de/)
* with Xamarin
* with UWP
* with .NET Desktop
2. Install GTKSharp for Windows
[download GTKSharp](https://www.mono-project.com/download/stable/#download-win)
3. Install capnproto
3.1 If you have Chocolatey installed Please see [https://fab-access.org/download](https://fab-access.org/download) for all download and build options!
```shell
$ choco install capnproto
```
3.2 else you can download it from [here](https://capnproto.org/install.html) and add it to your PATH
4. Clone Borepin # Server
[download Borepin](https://gitlab.com/fabinfra/fabaccess/client) Yoh will find proper documentation for setting up your own BFFH FabAccess Server at [https://fab-access.org/install](https://fab-access.org/install)
6. Load Borepin
7. Build Borepin
If Step 5. Build Borepin is failing because of GTKSharp, it could help to restart your PC.
## Build GTK Project
1. Install mono
[download mono](https://www.mono-project.com/download/stable/#download-lin)
2. Install mono, gtk-sharp, msbuild, nuget, capnproto
1.1 Debian based
```shell
$ apt install mono-complete, gtk-sharp2, libcanberra-gtk-module, nuget, capnproto, git
```
1.2 ArchLinux based
```shell
$ pacman -S mono, mono-msbuild, gtk-sharp-2, nuget, capnproto
```
3. Update NuGet
```shell
$ nuget update -self
```
3. Clone Borepin
```shell
$ git clone https://gitlab.com/fabinfra/fabaccess/client.git --recurse-submodules
```
4. Build Borepin
```shell
$ cd client
$ nuget restore
$ msbuild -t:Borepin_GTK
```
4. Run Borepin
```shell
$ mono ./Borepin/Borepin.GTK/bin/Debug/Borepin.GTK.exe
```
You can also use Rider or monodevelop as an IDE for development on Borepin
## macOS / iOS
1. Install Visual Studio for Mac
2. Install capnproto
If you install capnp with Homebrew you may have to symlink the capnp binary into '/usr/local/bin', or bring it into your PATH another way.
3. Clone Borepin
```shell
$ git clone https://gitlab.com/fabinfra/fabaccess/client.git --recurse-submodules
```
4. Open in Visual Studio
5. Build
# UI
We use [Xamarin](https://dotnet.microsoft.com/apps/xamarin) for our UI Implementation.
## Frameworks
We use [Prism Libary](https://prismlibrary.com/docs/xamarin-forms/Getting-Started.html) for MVVM and navigation managment.
# Testing
We use [NUnit](https://nunit.org/) for testing.