@geomak/giddy NPM

Version Updates (1.0.7)

1) Added scaffolding and deploy pipelines for .NET Core 3.1 Web API 2) Check the scaffold description section to see what it is included in the .NET Core 3.1 Web API scaffold. 3) Check the usage instructions section to see how to use the .NET scaffolding and deploy pipelines. 4) Check the dependencies section to see what else you will need to run .NET pipelines. 5) The init.json and deploy.json templates remain as they were

Version Updates (1.0.6)

1) Fixed scaffolding pipeline bugs for both React and Node apps. The previous pipeline was using the wrong exec command to create an Azure App Service. 2) Added checks for App Service Plans. Default creation SKU is FREE and you can scale according to your needs. 3) Fixed error handling promises. 4) Updated giddy-template for project scaffolding. See the templates section for the updated version of init.json

Version Updates (1.0.4)

1) Windows compatibility fixed. 2) Added scaffolding option for React and Node.js projects that provide you with ready to develop projects 3) Added cleanup handling in case of errors for git. (git reset --soft HEAD~1). See lower for conflict resolution tips 4) Async-Await implementation of pipelines, leading to a much cleaner code base 5) Tested on Ubuntu and Garuda Dragonized (Arch Linux) distros. 6) The cleanups are still in experimental phase except from the unstaging of a commit. 7) Shorter giddy-config.json templates and reduction to two instead of three 8) The double repository pattern for React projects is no longer supported.

What is Giddy

Giddy is an automated scaffolding and DevOps pipeline tool, built with Node.js that makes the setup and deployment of React and Node.js applications on Azure feel like a breeze. You simply provide Giddy with a .json config file, and the rest are done for you automatically (except from Git credentials insertion). However, forget about initializing projects, installing basic packages, building bundles, logging in, retrieving details, pushing to repositories, deploying etc.

Full project source code can be found here

Installation

In order to run Giddy from anywhere on your computer you need to install it globally.

npm i -g @geomak/giddy

After installing it, giddy will be available to run from your command line. Start by typing giddy -h to check the options.

Options

The below option will set the type of project you want to set up and deploy or simply deploy. Current options are react and node

-a or --app with two choices react or node

The below option will set the type of operation you want to perform for the selected type of project.

The option deploy allows you to re-deploy an already existing app you have on Azure.

The option init first creates an application of the selected app type, initializes repositories, updates them, and finally makes an initial deployment, in order to only use the deploy option in the future.

-t or --type with two choices deploy or init

Arguments

giddy requires a single argument which is the path to your giddy-config.json

Example usage

Deploy an existing React application on Azure

giddy -a react -t deploy absolute/path/to/deploy.json

Deploy an existing Node application on Azure

giddy -a node -t deploy absolute/path/to/deploy.json

Deploy an existing .NET Core 3.1 Web API application on Azure

giddy -a dotnet -t deploy absolute/path/to/deploy.json

Scaffold and deploy a new React application on Azure

giddy -a react -t init absolute/path/to/init.json

Scaffold and deploy a new Node.js application on Azure

giddy -a node -t init absolute/path/to/init.json

Scaffold and deploy a new .NET Core 3.1 Web API application on Azure

giddy -a dotnet -t init absolute/path/to/init.json

What you will need - Package dependencies

1) Node.js 2) Git 3) azure-cli ^2.0 4) .NET Core 3.1 (comes with dotnet cli)

JSON config templates

There are two standard templates that giddy recognizes and this is mostly to distinguish the deployment pipeline from the scaffolding pipeline.

Scaffold init.json

{
     "resource_group_name": "<name-of-resource-group> (existing or new)",
     "app_service_plan": "<name-of-app-service-plan> (existing or new)",
     "location": "<location of the service according to Azure standards. e.g. westeurope>",
     "app_name": "<the-name-to-give-to-the-app>",
     "git_username": "<your-git-username>",
     "git_password": "<your-git-access-token>(as from 13, Aug 2021)",
     "git_email": "<your-git-email>",
     "commit_message": "a commit message e.g. v1.0.0"
}

The above template is the standard scaffolding template that Giddy recognizes in order to initialize a new project of the selected type, and perform the initial operations (repo creation, app service creation, resource group creation, repository update, and finally the initial deploy). Once the pipeline is finished, you'll be prompted with a link to check your new application live. For Node.js apps, to check if the app is running after the pipeline, visit the /api/default/get route. In React applications, the form has embedded validations and will not let you submit it empty, so just type a random username and password, and it will let you in.

Deploy template

{
  "resource_group_name": "<the-resource-group-name-of-the-app>",
  "app_name": "<the-app-service-name>",
  "source_code_path": "absolute/path/to/source/code",
  "remote_name": "<name-of-source-code-remote> defaults to origin",
  "branch_name": "<name-of-source-code-branch> defaults to main",
  "commit_message": "v1.0.1",
  "git_username": "<your-git-username>",
  "git_password": "<your-github-access-token>"
}

The above template is the standard giddy-config.json template for the deployment of an existing app on Azure. It works for projects that aren't scaffolded with giddy as well, as long as the information are correct

Usage guide from scratch

Step 1: Create an Azure App Service

In Azure Portal click on App Services and then +Create to create a new App Service.

Create App Service

The name you will give to your app is what needs to be put in the "app_service_name" property of your giddy-config.json

Step 2: Create a React project

This applies to any React project, but for the sake of the tutorial let's go with a new empty project with create-react-app. Once scaffolding is finished, make sure that a local repository is initialized. If it isn't, initialize a local repository with git init and add /node_modules to it. The path to your project is what goes in the "source_code_path" property of your giddy-config.json

Step 3: Create the remote

Login to your GitHub account and create a repository, for your source code. Then create an authorization token to use as your password. From Aug 13, 2021 and onwards, GitHub uses authentication tokens instead of account passwords. Go to: 1) Your account settings 2) Developer settings 3) Personal access tokens 4) Generate new token 5) Follow the process 6) Save your token somewhere safe because you won't be able to see it again. Finally, link each remote with each local repository by doing:

git remote add <a remote name you want> <link to remote from your repo>

Step 4: Create your deploy.json

It's not the name deploy.json that matters most but the format and so, you can name it however you want as long as it has a .json extension and the format is correct. Copy the "deploy" template from above and replace the values of the properties with your matching ones. You can retrieve the remote and branch name by doing git remote and git branch respectively inside a repository. The current branch will be marked with a *

Step 5: Run giddy

Finally, open a terminal window and type

giddy -a react -t deploy /path/to/giddy-config.json

For example, if you are on Ubuntu and your giddy-config.json is on your Desktop type:

giddy -a react -t deploy /home/<your username>/Desktop/giddy-config.json

That's it! Save your giddy-config.json and continue developing your app. From now on, all you need to do whenever you want to build, push and deploy your application, is to change the commit message in your giddy-config.json and run giddy

The above five steps are equivalent to running giddy -a react -t init path/to/giddy-config.json .

Apart from the obvious benefits of brevity, giddy also provides you with all the tools that you

will need plus the boilerplate code for them. (packages, Context API, routes, styling...all the goodies to build upon)

Conflict resolution after git reset --soft HEAD~1

git add .

git commit -m "your commit message"

git pull <remote> <branch>

Fix conflicts manually and accept or abort changes

Rerun giddy

.NET Core 3.1 Web API scaffold packages

The .NET Core 3.1 Web API project includes:

1) SwaggerUI in /swagger route 2) JWT Authorization implementation for token and refresh token. 3) Two controllers showcasing partial controller authorization and total controller authorization. 4) 4 Total routes for Demo purpose check SwaggerUI in order to use them with an HTTP Client like Postman. 5) BCrypt library with functions to hash and verify user passwords. 6) Repository Pattern project structure

React scaffold packages

The React project includes:

1) react-router-dom 2) react-query 3) antd and ant-design icons 4) react-transition-group 4) Context API implementation 5) Three routes ('/' (login), '/home' (home), '/todo' (demo of react-query)) 6) A 404 fallback page in case a route is not in the router 7) Links to the documentation of each library

Node.js scaffold packages

The Node.js application includes:

1) Express.js 2) cors 3) body-parser 4) dotenv 5) nodemon 6) Four default demo routes ('/api/default/get', '/api/default/post', '/api/default/put', '/api/default/delete')

The goal is to set you up as quickly as possible, with a project that has all boilerplate code ready, initialized repositories, and the Azure resources necessary together with your first deployment. That way you can focus only on the development and deploy again your app through giddy in a single command.

Both scaffolds contain a web.config file specifically for IIS.