Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/compositionalit/safe-dojo
An introductory dojo to learn how to develop full stack web applications in F#
https://github.com/compositionalit/safe-dojo
dojo fsharp safe web-programming
Last synced: 2 days ago
JSON representation
An introductory dojo to learn how to develop full stack web applications in F#
- Host: GitHub
- URL: https://github.com/compositionalit/safe-dojo
- Owner: CompositionalIT
- Created: 2018-03-23T17:29:27.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-24T05:00:08.000Z (4 months ago)
- Last Synced: 2025-02-01T08:48:14.304Z (2 days ago)
- Topics: dojo, fsharp, safe, web-programming
- Language: F#
- Homepage:
- Size: 1.64 MB
- Stars: 378
- Watchers: 17
- Forks: 125
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SAFE Dojo
This self-study repository is designed to allow you to experience the SAFE stack based on a ready-made application that you can build on top of. It will take around 90 minutes for you to complete if you have no experience in any of these technologies.
The `master` branch contains the dojo to complete. Please read the [instructions.md](Instructions.md) for a guide on completing this dojo, to learn all about the [SAFE Stack](https://safe-stack.github.io/) and F#. There is a "completed" version in the `suggested-solution` branch.
## Install pre-requisites
You'll need to install the following pre-requisites in order to build SAFE applications
* [.NET SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) 8.0
* [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
```
Open the editor:
```bash
code .
```
Build and run in watch mode using the following command:
```bash
dotnet run
```
> NOTE: You may have to allow `dotnet` or `Server` access to your public and/or private network.
Then open `http://localhost:8080` in your browser. Arrange the windows so you can see both Code editor and the web browser.
## Use the app
Type a UK postcode into the web app, e.g. "SW1A 2AA". Press "Fetch"
## Completing the tasks
Search files (Ctrl+Shift+F or Edit --> Find in Files) and search through for "Task 1" to start completing the Dojo.
See [Instructions.md](Instructions.md) for further details and hints about the tasks.
## Going further: bundling your app
There is `Bundle` to package your app:
```bash
dotnet run -- Bundle
```
## Going further: deploying to Azure
This requires these prerequisites:
* [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli)
First time run
az login
Then set the name of your app in Build.fs. The name must be globally unique and contain only alphanumeric or hyphen characters.
```
let web = webApp {
name "my-cool-app" // set the name of your app here
...
```
To deploy to Azure:
```bash
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/)