Skip to content

Commit 5bfb9ee

Browse files
authored
Merge pull request SAFE-Stack#146 from theprash/master
Updates for FAKE and paket local dotnet tools in template
2 parents bca2fa1 + f620fc7 commit 5bfb9ee

File tree

9 files changed

+11
-18
lines changed

9 files changed

+11
-18
lines changed

docs/faq-troubleshooting.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
## Getting Started
22

3-
### FAKE cannot be found
4-
5-
If you fail to execute `fake` from command line after installing it as a global tool, you might need to add it to your `PATH` manually: (e.g. `export PATH="$HOME/.dotnet/tools:$PATH"` on unix) - [related GitHub issue](https://github.com/dotnet/cli/issues/9321)
6-
73
## Diagnostics
84

95
### SocketProtocolError in Debug Console

docs/quickstart.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,9 @@ This page provides some basic guidance on getting up and running with your first
55
You'll need to install the following pre-requisites in order to build SAFE applications
66

77
* The [.NET Core SDK 3.0](https://dotnet.microsoft.com/download/dotnet-core/3.0)
8-
* [FAKE](https://fake.build/) (>= 5.12) installed as global tool (`dotnet tool install -g fake-cli`)
9-
* [Paket](https://fsprojects.github.io/Paket) installed as global tool (`dotnet tool install paket --add-source https://www.myget.org/F/paket-netcore-as-tool/api/v3/index.json -g`) (optional\*)
108
* [node.js](https://nodejs.org/) (>= 8.0)
119
* [yarn](https://yarnpkg.com/) (>= 1.10.1\*\*) or [npm](https://www.npmjs.com/)
1210

13-
\* You don't need Paket if you just want to try out SAFE. However if you need to edit NuGet dependencies you can [read docs](https://fsprojects.github.io/Paket/getting-started.html) on how to get started with Paket. When installed as global tool you can invoke it via `paket` CLI
14-
1511
\*\* Yarn v2 is [not yet supported](https://github.com/SAFE-Stack/SAFE-template/issues/329)
1612

1713
## Install an F# code editor
@@ -28,7 +24,8 @@ You'll also want an IDE to create F# applications. We recommend one of the follo
2824
2. Open a command prompt
2925
3. Enter `dotnet new -i SAFE.Template` to install the [SAFE project template](template-overview.md)
3026
4. Enter `dotnet new SAFE` to create a new SAFE project
31-
5. Enter `fake build --target run` to build and run the app
27+
5. Enter `dotnet tool restore` to install local tools like FAKE.
28+
6. Enter `dotnet fake build --target run` to build and run the app
3229

3330
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.
3431

docs/template-appservice.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ An ARM template is a declarative JSON file which contains the details of the Azu
2828

2929
Deploying your application through FAKE is relatively simple. Use the following command:
3030
```
31-
fake build --target appservice
31+
dotnet fake build --target appservice
3232
-e subscriptionId=<subId>
3333
-e clientId=<clientId>
3434
-e tenantId=<tenantId>

docs/template-docker.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The SAFE template has the ability to easily create a [Docker](https://www.docker
1010
## Testing docker image locally
1111

1212
1. Make sure you have docker installed and created the template with `--deploy docker` option
13-
1. Run `fake build --target docker`
13+
1. Run `dotnet fake build --target docker`
1414
1. Run `docker run -d -it -p 8085:8085 {dockerUser}/{dockerImageName}`
1515
1. Navigate to `{dockerHost}:8085` url
1616

@@ -39,7 +39,7 @@ Create a file called `release.cmd` with the following content and configure your
3939
@echo off
4040
cls
4141

42-
fake build --target Deploy "DockerLoginServer=docker.io" "DockerImageName=****" "DockerUser=****" "DockerPassword=***" %*
42+
dotnet fake build --target Deploy "DockerLoginServer=docker.io" "DockerImageName=****" "DockerUser=****" "DockerPassword=***" %*
4343

4444
Don't worry the file is already in `.gitignore` so your password will not be commited.
4545

docs/template-fake.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Generated FAKE script consist of two primary build targets, used for different p
44

55
## **"Run"** target
66

7-
Enter `fake build --target run` to build and run the app
7+
Enter `dotnet fake build --target run` to build and run the app
88

99
This target is used for development purposes, and provides a great live-reload experience. It consists of following steps:
1010

docs/template-gcp-appengine.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ If you are already familiar with GCP and have `gcloud` in place, all you need to
88
```
99
dotnet new SAFE --deploy gcp-appengine
1010
gcloud app create
11-
fake build -t Deploy
11+
dotnet fake build -t Deploy
1212
gcloud app browse
1313
```
1414

docs/template-gcp-kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ If you are familiar with GCP and already have `gcloud` and `kubectl` configured
66

77
```
88
dotnet new SAFE --deploy gcp-kubernetes
9-
fake build -t Deploy
9+
dotnet fake build -t Deploy
1010
```
1111

1212
The quickstart assumes you have a default zone configured, and it will deploy to a cluster named `safe-cluster`. To change the cluster add `-e SAFE_CLUSTER=<kubernetes cluster>` to the `fake` command. To get the exposed IP you need to run the following command:

docs/template-heroku.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ After installing Heroku CLI and authenticating, the template makes the process o
1818

1919
```
2020
dotnet new SAFE --deploy heroku
21-
fake build -t Configure <optional app:create arguments>
22-
fake build -t Deploy
21+
dotnet fake build -t Configure <optional app:create arguments>
22+
dotnet fake build -t Deploy
2323
```
2424

2525
After these steps if everything went right, the project should open on the browser.

docs/template-iis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ dotnet new SAFE --deploy iis
99
The template will include a custom FAKE build target called `Bundle` to package your application and make it ready for deployment, run this target using:
1010

1111
```
12-
fake build --target bundle
12+
dotnet fake build --target bundle
1313
```
1414

1515
When the target finishes running succesfully, you will have a new `deploy` directory with this structure:

0 commit comments

Comments
 (0)