Skip to content

Commit 2d3dddb

Browse files
authored
Merge pull request #440 from SAFE-Stack/v5-update-readme
updated readme for the v5 release
2 parents 859f08f + bcd1fbb commit 2d3dddb

1 file changed

Lines changed: 12 additions & 15 deletions

File tree

README.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
1-
# SAFE Template
1+
# Introducing SAFE Bookstore
22

3-
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?
3+
[Deployed Demo](https://safebookstore.azurewebsites.net/)
4+
5+
## Demo
6+
7+
You'll need to install the following pre-requisites in order to build SAFE applications
48

59
## Install pre-requisites
610

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

9-
* [.NET SDK](https://www.microsoft.com/net/download) 8.0 or higher
10-
* [Node 18](https://nodejs.org/en/download/) or higher
11-
* [NPM 9](https://www.npmjs.com/package/npm) or higher
13+
* The [.NET 8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0)
14+
* [node.js](https://nodejs.org/) (v18.x or v20.x)
15+
* [npm](https://www.npmjs.com/) (v9.x or v10.x)
16+
* [docker](https://www.docker.com/products/docker-desktop/)
1217

13-
## Starting the application
18+
## Getting started
1419

1520
Before you run the project **for the first time only** you must install dotnet "local tools" with this command:
1621

@@ -24,18 +29,10 @@ To concurrently run the server and the client components in watch mode use the f
2429
dotnet run
2530
```
2631

27-
Then open `http://localhost:8080` in your browser.
32+
This will also spin up a local docker container with Azurite storage emulator which is used to save the wishlist data.
2833

2934
The build project in root directory contains a couple of different build targets. You can specify them after `--` (target name is case-insensitive).
3035

31-
To run concurrently server and client tests in watch mode (you can run this command in parallel to the previous one in new terminal):
32-
33-
```bash
34-
dotnet run -- RunTests
35-
```
36-
37-
Client tests are available under `http://localhost:8081` in your browser and server tests are running in watch mode in console.
38-
3936
Finally, there are `Bundle` and `Azure` targets that you can use to package your app and deploy to Azure, respectively:
4037

4138
```bash

0 commit comments

Comments
 (0)