Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated readme for the v5 release #440

Merged
merged 6 commits into from
Mar 8, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 12 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:

Expand All @@ -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
Expand Down
Loading