diff --git a/README.md b/README.md index 2cca3a3c..5bafffe4 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,21 @@ -# SAFE Template +# Introducing SAFE Bookstore -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? +[Deployed Demo](https://safebookstore.azurewebsites.net/) + +## Demo + +You'll need to install the following pre-requisites in order to build SAFE applications ## 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 +* The [.NET 8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0) +* [node.js](https://nodejs.org/) (v18.x or v20.x) +* [npm](https://www.npmjs.com/) (v9.x or v10.x) +* [docker](https://www.docker.com/products/docker-desktop/) -## Starting the application +## Getting started Before you run the project **for the first time only** you must install dotnet "local tools" with this command: @@ -24,18 +29,10 @@ To concurrently run the server and the client components in watch mode use the f dotnet run ``` -Then open `http://localhost:8080` in your browser. +This will also spin up a local docker container with Azurite storage emulator which is used to save the wishlist data. 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