Overview

Repositories

In my approach to this semester I'm going to use five repositories below:

• Project 1 - Agile & Scrum: Kanban Project
• Project 2 - API Development
• Project 3 - Standards & Patterns
• Project 4 - Testing & RPA
• Project 5 - Reporting & Monitoring

Context Diagram

Regarding my project I'm going to have each repository for each project if source control is needed. Essentially I'm going to have 5 different repositories and one project where all the of them come together through one "Kanban".

Branching Strategy

In all of my projects, Branching strategies will be used since I want to avoid conflicts when I am merging them and also allow a much easier integration of changes made into the main trunk. Moreover, to help organize a series of planned, structured releases. A branching strategy that I will be using in all of my projects is GitHub-Flow. Since all of the projects are individually and we have a single release version for each of our projects for each repository, GitHub-Flow is the winner for me. GitHub Flow is a simple and effective way to support continuous deployment and release. It gives me a delivery-focused project as possible.

Implementation

Most of my Implementation I will be using branches after major changes I push to my main branch and delete the branch I created.

• The main is being branched to the feature branch, then code is added to the feature branch.
• A pull request is created and pushed to pre-production while adding things and fixing bugs, when I'm content with the release I merge back to main.

This strategy eliminates a lot of room for error, if something goes wrong, I can simply roll back to the previous version.

• The GitHub Flow branching strategy will consist of the following branches:
• Master (main) - for production purposes
• Feature/task - for the development of new features
• Hotfix - to assist when there's a bug that has been found and needs fixing in production. A hotfix originates from the master branch and merges back into the master and develops.

.gitignore files

In my API Project, I'll use gitignore to ignore the JSON files anytime I save code in a public repository and want to secure it so that it’s not publicly accessible.

Under my MVC Web Application, I intend to use gitignore to ignore the bin, obj folders and JSON files; I just want the source code in source control. Moreover I will store all the Connection Strings in .JSON file and gitignore them.

In terms of RPA & Testing , I'm going to gitignore files like entities, local, templates, screenshots, settings, tmh

In Reporting project there won't be files that will be ignored.

Storage of Credentials

In terms of storing sensitive credentials:

• I’ll utilize a .JSON file in API Development and Standards & Patterns.
• In Testing & RPA, credentials will be stored in UiPath Orchestrator.
• In Reporting there will not be credentials that need to be stored.

Reference List

• Nick Chapsas. (2021, Aug 10). Getting started with branching workflows, Git Flow and GitHub Flow. [Video]. YouTube. https://youtu.be/gW6dFpTMk8s
  

• Valaxy Technologies. (2020, Oct 6).Branching Strategies on Git | Real-time Git Branching Strategy for a DevOps project. [Video]. YouTube https://youtu.be/Bg8tiOLZw4A
  

• Adam Marczak. (2020, Oct 21). AZ-900 Episode 27 | Azure Key Vault | Secret, Key and Certificate Management. [Video]. YouTube https://youtu.be/AA3yYg9Zq9w
  

• Devchild. (2018, Sept 2). The gitflow workflow - in less than 5 mins. [Video]. YouTube https://youtu.be/1SXpE08hvGs
  

• Rowan Haddad. (2022). What Are the Best Git Branching Strategies. Git Branching Strategies: GitFlow, Github Flow, Trunk Based. Date of access: 08 March 2022.
  

• David Coulter. (2021). Quickstart: Set and retrieve a secret from Azure Key Vault using the Azure portal. Quickstart: Set and retrieve a secret from Azure Key Vault using the Azure portal. Date of access: 14 Dec. 2021.
  

• Tara Rosen. (2020). How To Create A .gitignore File To Hide Your API Keys. How To Create A .gitignore File To Hide Your API Keys. Date of access: 20 Mar. 2020

• Quang Nguyen. (2021). Git-Flow vs GitHub-Flow. Git-Flow vs GitHub-Flow. Git vs GitHub pros and cons. continuous… | by Quang Nguyen | Medium. Date of access: 10 Sep 2021.
  

• CodeWall. (2019). A Git-Flow Explainer & How To Tutorial.A Git-Flow Explainer & How To Tutorial - Code Wall. Date of access: 30 May 2019.
  

• Zhou, W., Li, L., Luo, M. and Chou, W., 2014, May. REST API design patterns for SDN northbound API. In 2014 28th international conference on advanced information networking and applications workshops (pp. 358-365). IEEE.
  

• Sohan, S.M., Maurer, F., Anslow, C. and Robillard, M.P., 2017, October. A study of the effectiveness of usage examples in REST API documentation. In 2017 IEEE Symposium on Visual Languages and Human-Centric Computing (VL/HCC)(pp. 53-61). IEEE.
  

• Masse, M., 2011. REST API design rulebook: designing consistent RESTful web service interfaces . " O'Reilly Media, Inc."
  

• Chadwick, J., Snyder, T. and Panda, H., 2012. Programming ASP. NET MVC 4: Developing Real-World Web Applications with ASP. NET MVC. " O'Reilly Media, Inc."
  

• Soni, A. and Ranga, V., 2019. API features individualizing of web services: REST and SOAP.International Journal of Innovative Technology and Exploring Engineering , 8(9), pp.664-671.
  

• Mumbaikar, S. and Padiya, P., 2013. Web services based on soap and rest principles. International Journal of Scientific and Research Publications, 3(5), pp.1-4.
  

• Halili, F. and Ramadani, E., 2018. Web services: a comparison of soap and rest services. Modern Applied Science, 12(3), p.175.
  

• De, B., 2017. API documentation. In API Management (pp. 59-80). Apress, Berkeley, CA.
  

• Haunts, S., 2019. Key Storage and Azure Key Vault. In Applied Cryptography in. NET and Azure Key Vault (pp. 143-168). Apress, Berkeley, CA.
  

• Herath, P., 2022. Working with Azure Key Vault. In Azure Cloud Security for Absolute Beginners (pp. 71-91). Apress, Berkeley, CA.
  

• MuleSoft Videos. (2015, Jun 20). What is an API?. [Video]. YouTube https://youtu.be/s7wmiS2mSXY
  

• Simply Explained. (2019, Nov 12). What Are APIs? – Simply Explained. [Video]. YouTube https://youtu.be/OVvTv9Hy91Q
  

• Imperva. (2019, Nov 16). API Security Explained. [Video]. YouTube https://youtu.be/LeVQlxLVD8A
  

• Nordic APIs. (2019, May 28). 5 Best Practices for Securing Your APIs. [Video]. YouTube https://youtu.be/6wRuKgjbBVU
  

• Udacity (2016, Jun 6). Token Based Authentication. [Video]. YouTube https://youtu.be/woNZJMSNbuo
  

• WafaStudies. (2020, Jun 5). Store Secrets in Azure Key Vault using Azure Portal. [Video]. YouTube https://youtu.be/Rb7qz_emvsg
  

• Paddy Maddy. (2020, Dec 24). Storage Account service Encryption Azure KeyVault secret key encryption. [Video]. YouTube https://youtu.be/N6nNJ_NrbS4
  

• C. Nienaber & R. Suter. (2022, Mar). ASP.NET Core web API documentation with Swagger / OpenAPI. https://docs.microsoft.com/en-us/aspnet/core/tutorials/web-api-help-pages-using-swagger?view=aspnetcore-3.1

• R. Anderson & K. Larkin. (2022, Aug).Tutorial: Create a web API with ASP.NET Core. https://docs.microsoft.com/en-us/aspnet/core/tutorials/first-web-api?view=aspnetcore-6.0&tabs=visual-studio

• R. Anderson & K. Larkin. (2022, Jul). Configuration in ASP.NET Core. https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration/?view=aspnetcore-6.0

• Sanjay. (2021, Jul). Entity Framework Core in ASP.NET Core 3.1 – Getting Started. https://procodeguide.com/programming/entity-framework-core-in-asp-net-core/

• J. Muller. (2022, Jan). Join two entities in.NET Core, using lambda and Entity Framerwork Core. https://jd-bots.com/2022/01/24/join-two-entities-in-net-core-using-lambda-and-entity-framework-core/

• M. Soucoup. (2022, Mar). Publish an ASP.NET Core web API to Azure API Management with Visual Studio . https://docs.microsoft.com/en-us/aspnet/core/tutorials/publish-to-azure-api-management-using-vs?view=aspnetcore-6.0

• Price, M.J., 2019. C# 8.0 and. NET Core 3.0–Modern Cross-Platform Development: Build applications with C#,. NET Core, Entity Framework Core, ASP. NET Core, and ML. NET using Visual Studio Code. Packt Publishing Ltd.

• Chanda, S. and Foggon, D., 2013. Introducing Language-Integrated Query (LINQ). In Beginning ASP. NET 4.5 Databases (pp. 79-98). Apress, Berkeley, CA.

• Azure Crash Course. Azure API Management Crash Course. [Video]. YouTube https://youtu.be/3z_XmIrGbsI

• DEVREAL. Azure API Management in 7 (from provisioning to API deployment) - tutorial for beginners. [Video]. YouTube https://youtu.be/Gu9reN09mXI

• Microsoft Azure. Azure API Management. [Video]. YouTube https://youtu.be/0yf_xm5cPIo

• Reval Govender. Git Flow Part 1 - What is Git Flow. [Video]. YouTube https://youtu.be/6LhTe8Mz6jM

• Microsoft (2020). ASP.NET MVC Overview. https://learn.microsoft.com/en-us/aspnet/mvc/overview/older-versions-1/overview/asp-net-mvc-overview

• Microsoft. Secure a .NET web app with the ASP.NET Core Identity framework. https://learn.microsoft.com/en-us/training/modules/secure-aspnet-core-identity/

• Microsot. Build web apps with ASP.NET Core for beginners. https://learn.microsoft.com/en-us/training/paths/aspnet-core-web-app/

• Kanchan Naik (2021, June 17). Design Patterns In C# .NET . https://www.c-sharpcorner.com/UploadFile/bd5be5/design-patterns-in-net/

• Manikavelu Velayutham (2012, May 13). Architectural Patterns in .NET. https://www.c-sharpcorner.com/uploadfile/babu_2082/architectural-patterns-in-net/

• Microsoft (2022). Design the infrastructure persistence layer. https://learn.microsoft.com/en-us/dotnet/architecture/microservices/microservice-ddd-cqrs-patterns/infrastructure-persistence-layer-design

• Bergman (2017, 20 April). Repository Design Pattern . https://medium.com/@pererikbergman/repository-design-pattern-e28c0f3e4a30

• M. Coetzee & J. Muller. 2022, 8 Sept. Patterns Intro .[Video]. Patterns Intro

• M. Coetzee & J. Muller. 2022, 15 Sept. Design Patterns .[Video]. Design Patterns

• M. Coetzee. 2022, 13 Sept. Best practise and standards .[Video]. Best practise and standards

• M. Coetzee. 2022, 13 Sept. WebApp demo .[Video]. WebApp demo

• M. Coetzee & J. Muller. 2022, 20 Sept. Project 3 repository Pattern concepts. [Video] . Project 3 repository Pattern concepts