generator-team-ignite-tour/generators/product-service/templates/README.md

Generates a demo environment in Azure DevOps

# Tailwind Traders Product Service

This project requires Node.js 8+ as well CosmosDB or MongoDB running somewhere.

1. Create a file called `.env` in `<project>/src/frontend/`
1. Put these variables in it:
   - `DB_CONNECTION_STRING` — CosmosDB or MongoDB URL – make sure it has the db name in it. If you're pulling from CosmosDB, make sure to add a `/tailwind` (or whatever you called it in `DB_NAME`) after the port but before the query string
   - `DB_NAME` — Name of DB in CosmosDB or MongoDB. default `tailwind`
   - `COLLECTION_NAME` — Name of collection in db. default `inventory`
   - `ITEMS_AMOUNT` — If running the `populate:mongodb` script, how many total items to fill the DB with. default `10000`
   - `IMAGE_SIZE` — If running the `populate:mongodb` script, what size of images to use. default: `250`
   - `PG_CONNECTION_STRING` — If running the `populate:mongodb` script, an optional param to draw data from a Postgres database first before filling the rest of the MongoDB/CosmosDB instance with random data. optional
   - `PORT` — What port to start the service on. default `8000` – don't add this to your .env unless you _definitely_ need it
   - `HOSTNAME` — What hostname the server is hosted on. default: `localhost` – don't add this to your .env unless you _definitely_ need it
   - `CORS` - Which URL would you like to restrict CORS to? By default it is set to '\*'.

**OR**

1. In your `.env` file, put the following variables:
   - `KEYVAULT_URI` — URI of your Azure Key Vault
   - `KEYVAULT_ID` — ID of your Azure Key Vault
   - `KEYVAULT_SECRET` — ID of your Azure Key Vault
   - All of the above keys you have loaded in the Key Vault will be available in the app
   
## To Populate ComsosDB or MongoDB with fake data

1. `cd` to this directory, `<project>/src/product-service/`
1. `npm install`
1. If you need to pull from a Postgres DB, make sure you have a connection string for it in your `.env`
1. Drop the previous collection if you're re-using a collection
1. Run `npm run populate:mongodb`

## To Develop

1. `cd` to this directory, `<project>/src/product-service/`
1. `npm install`
1. `npm run dev`
1. Project will be running on host and port you specified, defaults to http://localhost:8000
1. Adhere to the Prettier and ESLint rules before checking in

## To Run in Production

1. `cd` to this directory, `<project>/src/frontend/`
1. `npm install`
1. `npm start`
1. Project will be running on host and port you specified

## To Deploy To Azure

### From Azure CLI

1. Create a new Resource Group with a data center location. You can substitute "westus" here for any other data center location.

   For a list of locations, run `az account list-locations`.

   ```
   az group create -n {Your Resource Group Name} -l westus
   ```

1. Create a new Service Plan. Select the S1 tier. This tier performs faster for demos. Also make sure you specify that you want a Linux server.
   ```
   az appservice plan create -n {Your Service Plan Name} --sku S1 --is-linux -g {Your Resource Group Name}
   ```
1. Create a new App Service site to hose the Product Service API. Specify a Node version to use as well. At the time of this writing, the current LTS version of Node in Azure is 8.11.

   For a complete list of supported Node versions, run `az webapp list-runtimes`.

   ```
   az webapp create -n {Your App Name} -p {Your Service Plan Name} -g {Your Resource Group Name} --runtime 'node|8.11'
   ```

1. Zip up all of the project files, excluding the `node_modules` folder. An `npm install` will be run by Azure after the zip is deployed. Make sure you are in the project directory when you run this.

   ```
   zip -r Deployment . -x "node_modules/**/*"
   ```

1. Deploy the zip file to Azure

   ```
   az webapp deployment source config-zip -g {Your Resource Group Name} -name {Your App Name} --src Deployment.zip
   ```

1. Add an application setting that points to your Products Cosmos DB database instance.

   ```
   az webapp config appsettings set -n {Your App Name} --settings "COSMOSDB_OR_MONGODB_CONNECTION_STRING={Your Cosmos DB Connection String}" -g {Your Resource Group}
   ```

1. Open the app in a browser...
   ```
   az webapp browse -n {Your App Name} -g {Your Resource Group Name}
   ```
   ...and then navigate to `api/products` to see some data.