Skip to content

Updated Readme with defined steps #5

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.

Sign up for GitHub

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

Open
LeeSchuenemeyer wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updated Readme with defined steps #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 17 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,15 +136,15 @@ Failed to register free address space

The UpdateAddressSpaceTimer Azure Function is a timer function which is scheduled to run every day at 9:30 AM. If you want to change the schedule please change the [function.json](https://github.com/stefanstranger/AIPAS/blob/master/src/function/UpdateAddressSpaceTimer/function.json) schedule configuration.

## Requirements
## Azure Requirements

Azure Subscription with:
An Azure Subscription with at least contributer rights containing the following:

- Resource Group
- Azure Storage Account and Storage Table
- Azure Function
- a Resource Group
- an Azure Storage Account and Storage Table
- an Azure Function

## Local development
## Local development requirements

If you want to further develop or test AIPAS you need to install the following prerequisites on your Windows development machine.

Expand All @@ -160,15 +160,15 @@ If you installed [Chocolatey](https://chocolatey.org/) (a Windows Apt-Get kinda

```PowerShell
# Install Git
choco install git
choco install git -fy
# Install VSCode
choco install vscode
choco install vscode -fy
# Install Azure Function Core Tools
choco install azure-functions-core-tools-3
choco install azure-functions-core-tools-3 -fy
# Install PowerShell Core
choco install pwsh
choco install pwsh -fy
# Install HttpMaster
choco install httpmaster-express
choco install httpmaster-express -fy
```

### Clone AIPAS Repository
Expand All @@ -177,7 +177,7 @@ choco install httpmaster-express
git clone https://github.com/stefanstranger/AIPAS.git
```

### Install PowerShell Modules
### Install PowerShell Modules via included Bootstrap.ps1 script

After cloning the Git Repository you can use the bootstrap.ps1 script to install the required PowerShell modules.

Expand All @@ -188,12 +188,14 @@ The following PowerShell Modules need to be installed:
- InvokeBuild
- Pester
- PlatyPS
- Az PowerShell modules*

\* The installation of the Az PowerShell modules are not part of the bootstrap.ps1 script. If you have not installed these PowerShell modules run Install-Module -Name Az on your development machine.

### Install Az PowerShell module

The installation of the Az PowerShell modules are not part of the bootstrap.ps1 script. To install or upgrade the Az PowerShell module, run the follwing in a elevated permisions PowerShell session:

```PowerShell
Install-Module -Name Az -Force
```
### Deploy Azure Storage Table

Within the Git Repository there are Azure Resource Manager Template files that can be used to deploy a new Resource Group with an Azure Storage Table.
Expand Down