Skip to content

Commit

Permalink
Updating template README, adding images
Browse files Browse the repository at this point in the history
  • Loading branch information
croblesm committed May 23, 2024
1 parent 9d3efb4 commit 55ac659
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 20 deletions.
Binary file added DevContainers-AzureSQL.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 34 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,32 @@
# Azure SQL Database Dev Container Templates

<table style="width: 100%; border-style: none;"><tr>
<td style="width: 140px; text-align: center;"><a href="https://github.com/devcontainers"><img width="128px" src="https://raw.githubusercontent.com/microsoft/fluentui-system-icons/78c9587b995299d5bfc007a0077773556ecb0994/assets/Cube/SVG/ic_fluent_cube_32_filled.svg" alt="devcontainers organization logo"/></a></td>
<table style="width: 100%; border-style: none;">
<tr>
<td style="width: 140px; text-align: center;">
<a href="https://github.com/devcontainers">
<img width="128px" src="https://raw.githubusercontent.com/microsoft/fluentui-system-icons/78c9587b995299d5bfc007a0077773556ecb0994/assets/Cube/SVG/ic_fluent_cube_32_filled.svg" alt="devcontainers organization logo"/>
</a>
</td>
<td>
<strong>Azure SQL Database Dev Container Templates</strong><br />
Streamlined development environments for Azure SQL Database using Dev Containers.
</td>
</tr></table>
</tr>
</table>


## Overview

In the quest to enhance local development for Azure SQL Database, this repository provides a comprehensive solution leveraging the power of Dev Containers. These templates offer developers a seamless and efficient development environment, enabling them to build applications for Azure SQL Database with ease and confidence. Dev Containers can be utilized in any development environment, including the cloud, promoting consistency across teams and workflows.

![DevContainers-AzureSQL](DevContainers-AzureSQL.png)

Our Dev Container templates simplify the development process by providing pre-configured environments that eliminate the need for manual setup. Developers can start coding immediately with all necessary tools and dependencies in place, using popular languages like `.NET`, `Node.js`, and `Python`.

The local development environment mimics Azure SQL Database, allowing developers to manage data and test applications efficiently. Once ready, **GitHub Actions** automate the deployment process, transitioning seamlessly to **Azure Static Web Apps** and **Azure SQL Database**. This streamlined workflow enhances productivity, reduces setup time, and ensures consistency between local and production environments, helping developers deliver high-quality applications faster.

Thank you for joining us on this journey to enhance the Azure SQL Database development experience. We look forward to your feedback and contributions!

## Problem Statement

Developers face significant challenges in setting up efficient local development environments for Azure SQL Database:
Expand All @@ -21,6 +36,22 @@ Developers face significant challenges in setting up efficient local development
- **Dependency on Cloud Resources**: Increased cloud costs and reliance on internet connectivity.
- **Limited Integration**: Lack of integration with existing Azure development tools.

### Addressing the Gap in Local Development Environments

We recognize the need for efficient local development environments tailored to Azure SQL Database. Our Dev Containers bridge this gap, enhancing developer experiences and fostering innovation within the Azure ecosystem. This initiative positions Azure SQL Database as a versatile and developer-centric platform.

### Accelerating Time-to-Market

Dev Containers streamline the development lifecycle, enabling developers to focus on coding and testing without the hassle of environment setup. This efficiency leads to faster iterations, higher-quality applications, and a reduced time-to-market for applications built on Azure SQL Database, giving businesses a competitive edge.

### Cost-Efficiency and Scalability

Local development with Dev Containers reduces cloud costs associated with development and testing in Azure environments. This optimization of resources improves cost-efficiency and scalability. Developers can transition seamlessly from local development to Azure environments, leveraging the scalability and reliability of Azure SQL Database for production deployments without incurring unnecessary costs.

### Alignment with Cloud-Native Trends

Dev Containers support cloud-native development scenarios, aligning with modern application architectures and frameworks. This ensures compatibility with Azure SQL Database and facilitates seamless deployment to Azure environments. By embracing cloud-native trends, we position Azure SQL Database as the platform of choice for modern, cloud-native applications, driving long-term adoption and revenue growth.

## Why Dev Containers, Docker, and VS Code?

Dev Containers, Docker, and VS Code are pivotal tools for modern developers:
Expand All @@ -46,23 +77,6 @@ This repository includes Dev Container templates for the following frameworks:

Each template comes with a pre-configured Azure SQL Database, making it easy to start developing right away.

## How to Use the Templates

### 1. Using Supporting Tools

Tools like [Visual Studio Code](https://code.visualstudio.com/) and [GitHub Codespaces](https://docs.github.com/en/codespaces/overview) support Dev Container templates. These tools provide a user-friendly interface to configure and use the templates.

### 2. Using the Dev Container CLI

The [@devcontainers/cli](https://containers.dev/supporting#devcontainer-cli) allows you to apply templates from the supported OCI registry.

#### Example

```sh
devcontainer templates apply --workspace-folder . \
--template-id ghcr.io/devcontainers/templates/azure-sql:latest
```

## Contributions

### Creating your own collection of templates
Expand Down

0 comments on commit 55ac659

Please sign in to comment.