azure-samples / openhack-production

This is a WIP (Work in Progress) sample for the new Production OpenHack

page_type	languages	products	description	urlFragment
sample	csharp	dotnet	Add 150 character max description	update-this-to-unique-url-stub

Production Fundamentals OpenHack Sample Application

This is a replica of the Urlist website but re-architected to use Azure AppService to host the backend instead of using Azure Functions. The original project repository can be found here https://github.com/the-urlist

Please check here to view and read about the architecture.

---

Table Of Contents

• Glossary
• Contents
• Prerequisites
• Setup
• Running the sample
• Contributing

Glossary

• Vanity URL: is a descriptive, human-readable, an easy to remember URL that is typically created to simplify sharing a long and hard-to-remember URLs.
• Link Bundle: a bundle/list of URLs that the user associated with a vanity URL using the Urlist application.

Contents

Outline the file contents of the repository. It helps users navigate the codebase, build configuration and any related assets.

File/folder	Description
api	The backend code base implemented using .Net Core.
frontend	The frontend code base implemented using VUE and Typescript
deployment	This folder holds deployment scripts to setup infrastructure.
pipelines	This folder holds YAML files to create Azure pipelines to deploy the project
docs	This folder holds relevant documentation about the project
.gitignore	Define what to ignore at commit time.
CHANGELOG.md	List of changes to the sample.
CONTRIBUTING.md	Guidelines for contributing to the sample.
README.md	This README file.
LICENSE	The license for the sample.

Setup

You need to have an Azure subscription available to setup the Urlist application and it's infrastructure.

Infrastructure

• Refer to the deployment guide to setup the Azure infrastructure automatically.
• Refer to the pipelines guide to create the needed pipelines to automate deployments and infrastructure updates.

Urlist Application

• Refer to the backend guide to setup the backend service.
• Refer to the frontend guide to setup the frontend service.

Linting

Refer to the linting guide to set up the environment.

Running the Application

Once the pipelines are setup and had successfully deployed the project, find your Azure Front Door endpoint and use it to test the website.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.