Quick Start

This page provides some basic guidance on getting up and running with your first SAFE application.

Install pre-requisites

You'll need to install the following pre-requisites in order to build SAFE applications

** Yarn v2 is not yet supported

Install an F# code editor

You'll also want an IDE to create F# applications. We recommend one of the following great IDEs.

Create your first SAFE app

  1. Create a new directory on your machine
  2. Open a command prompt
  3. Enter dotnet new -i SAFE.Template to install the SAFE project template
  4. Enter dotnet new SAFE to create a new SAFE project
  5. Enter dotnet tool restore to install local tools like FAKE.
  6. Enter dotnet fake build --target run to build and run the app

Congratulations - after a short delay, you'll be presented with a basic SAFE application running in your browser! The application will by default run in "development mode", which means it automatically watches your project for changes; whenever you save a file in the client project it will refresh the browser automatically; if you save a file in the server project it will also restart the server in the background.

Take a look at the template options. There are several ways to customise the default application, such as server and client/server communication technologies.


Still have issues getting started? Check out the troubleshooting page.