Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nfdi4plants/helpdesk
DataPLANT helpdesk as SPA website with server for creating MS Teams issues.
https://github.com/nfdi4plants/helpdesk
fable fsharp safe-stack
Last synced: about 4 hours ago
JSON representation
DataPLANT helpdesk as SPA website with server for creating MS Teams issues.
- Host: GitHub
- URL: https://github.com/nfdi4plants/helpdesk
- Owner: nfdi4plants
- Created: 2022-02-03T13:11:32.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-06T11:27:41.000Z (9 months ago)
- Last Synced: 2024-12-10T21:11:45.520Z (about 2 months ago)
- Topics: fable, fsharp, safe-stack
- Language: F#
- Homepage: https://helpdesk.nfdi4plants.org
- Size: 1.9 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# nfdi-helpdesk
This project is a helpdesk implementation based on the SAFE stack framework for the nfdi4plants/DataPLANT organisation. Some of it's features are:
- Full keyboard support, through nested dropdowns.
- Setting title with entry url query.
- dotnet native and fully customizable image captcha logic.
- Writing input to Microsoft Teams planner tasks.
# Procedure
```mermaid
---
title: DataPLANT Helpdesk
config:
sequence:
showSequenceNumbers: true
---
sequenceDiagram
actor User
participant Frontend
participant Backend
participant MSTeams
Note over Frontend,Backend: SAFE stack
User ->> Frontend: Fill Form
User ->> Frontend: Write Captcha
Frontend ->> Backend: Verify Captcha
Backend ->> Frontend: Confirm Captcha
User ->> Frontend: Submit
Frontend ->> Backend: Submit
Backend->>MSTeams: Send to task planner
create actor DataStewards
MSTeams ->> DataStewards : Notify
DataStewards --) DataStewards: Distribute to correct member
Backend ->> Frontend: Confirm successful submit
Frontend ->> User: Confirm successful submit
link Frontend: Page @ https://helpdesk.nfdi4plants.org/
link Frontend: React @ https://reactnative.dev/
link Frontend: ProgrammingLanguage (F#, Fable) @ https://fable.io/
link Backend: aspnetcore @ https://learn.microsoft.com/en-us/aspnet/core/introduction-to-aspnet-core?view=aspnetcore-8.0
link Backend: ProgrammingLanguage (F#) @ https://safe-stack.github.io/
```
## Dev
### Run in development
#### Install pre-requisites
You'll need to install the following pre-requisites in order to build SAFE applications
* [.NET Core SDK](https://www.microsoft.com/net/download) 6.0 or higher
* [Node LTS](https://nodejs.org/en/download/)
#### Starting the application
Before you run the project **for the first time only** you must install dotnet "local tools" with this command:
```bash
dotnet tool restore
```
To concurrently run the server and the client components in watch mode use the following command:
```bash
dotnet run
```
Then open `http://localhost:8080` in your browser.
The build project in root directory contains a couple of different build targets. You can specify them after `--` (target name is case-insensitive).
#### Test on native mobile device
Install [localtunnel](https://github.com/localtunnel/localtunnel)
```bash
npm install -g localtunnel
```
Open port on localtunnel api
```bash
lt --port 8080
```
**Tests not implemented**
To run concurrently server and client tests in watch mode (you can run this command in parallel to the previous one in new terminal):
```bash
dotnet run -- RunTests
```
### Docker Publish
Start docker then use:
```bash
dotnet run docker-publish
```
__OR__
Step by step
1. Create image
```bash
docker build -t nfdi-helpdesk .
```
2. Test image
```bash
docker run -it -p 8085:8085 nfdi-helpdesk
```
3. Create tag for image
```bash
docker tag nfdi-helpdesk:latest freymaurer/nfdi-helpdesk:X.X.X
```
Remember to replace "X.X.X" with the correct next SemVer version.
4. Push the image
```bash
docker push freymaurer/nfdi-helpdesk:X.X.X
```
### Bundle
#### Fonts for captcha creation
Add fonts as itemgroup to Server.fsproj as such:
```xml
Always
Always
Always
```
## SAFE Stack Documentation
If you want to know more about the full Azure Stack and all of it's components (including Azure) visit the official [SAFE documentation](https://safe-stack.github.io/docs/).
You will find more documentation about the used F# components at the following places:
* [Saturn](https://saturnframework.org/)
* [Fable](https://fable.io/docs/)
* [Elmish](https://elmish.github.io/elmish/)