https://github.com/compositionalit/fluentui-safe
https://github.com/compositionalit/fluentui-safe
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/compositionalit/fluentui-safe
- Owner: CompositionalIT
- Created: 2024-04-26T15:32:13.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-26T15:33:23.000Z (almost 2 years ago)
- Last Synced: 2025-06-09T12:46:01.952Z (9 months ago)
- Language: F#
- Size: 96.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SAFE Template
This template can be used to generate a full-stack web application using the [SAFE Stack](https://safe-stack.github.io/). It was created using the dotnet [SAFE Template](https://safe-stack.github.io/docs/template-overview/). If you want to learn more about the template why not start with the [quick start](https://safe-stack.github.io/docs/quickstart/) guide?
## Install pre-requisites
You'll need to install the following pre-requisites in order to build SAFE applications
* [.NET SDK](https://www.microsoft.com/net/download) 8.0 or higher
* [Node 18](https://nodejs.org/en/download/) or higher
* [NPM 9](https://www.npmjs.com/package/npm) or higher
## 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).
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
```
Client tests are available under `http://localhost:8081` in your browser and server tests are running in watch mode in console.
Finally, there are `Bundle` and `Azure` targets that you can use to package your app and deploy to Azure, respectively:
```bash
dotnet run -- Bundle
dotnet run -- Azure
```
## 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/)