Skip to content

Commit

Permalink
updated the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Artur Yapparov committed Sep 15, 2023
1 parent 6e673c9 commit 8e560a6
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ The Azure Maps Manifest Tool allows to interactively generate manifest files req

## Getting Started

1. Download the latest [Node.js LTS](https://nodejs.org/en/download/) and install Node.js, if you don't have it already installed.
1. Download [Node.js LTS](https://nodejs.org/en/download/) and install Node.js, if you don't have it already installed. Version 18 is recommended.
2. To install dependencies, run `npm install`.

After installing deps you may see concerning security messages like `6 high severity vulnerabilities`. Please don't try to fix it by running `npm audit fix --force` as it may break your build. \
After installing deps you may see concerning security messages like `6 high severity vulnerabilities`. Don't try to fix it by running `npm audit fix --force` as it may break your build. \
These vulnerabilities can be safely ignored as affected packages are only used in dev. To check production dependencies you may run `npm audit --production`, which should return `found 0 vulnerabilities`.

## Available commands
Expand Down Expand Up @@ -39,6 +39,9 @@ See the section about [End-to-End Testing](https://docs.cypress.io/guides/end-to
Builds the app for production to the `build` folder.\
It bundles React in production mode and optimizes the build for the best performance.

If you plan to deploy to test environment you may want to add env variable REACT_APP_STAGING_ENV=true.\
This will add test endpoint to regions.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

Expand Down

0 comments on commit 8e560a6

Please sign in to comment.