Skip to content
microsoftPublic

About

SQL Apps gives you a working application foundation and guides for creating your own screens, data and workflows with the AI assistant of your choice. You can start with an idea rather than a framework choice.

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

112 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SQL Apps

SQL Apps icon: a blue database with a purple application ribbon

Start free. Build something real. Make it yours.

SQL Apps gives you a working application foundation and guides for creating your own screens, data and workflows with the AI assistant of your choice. You can start with an idea rather than a framework choice.

What will you build?

  • An equipment checkout app that records loans and returns.
  • An inventory app that helps a team find and update stock.
  • A registration app that collects and manages signups.
  • A small team workflow where signed-in members with the right role review and update shared records.

These are ideas for your own application, not prebuilt templates. SQL Apps includes a separate Todo reference app if you want to try a concrete example first.

Install the SQL Apps plugin

One seven-skill bundle serves Claude Code and GitHub Copilot. Claude Code users can run:

claude plugin marketplace add microsoft/sql-apps
claude plugin install sql-apps@sql-apps-skills

See assistant installation and loader verification for Claude details and the native support matrix.

With the GitHub Copilot CLI installed and signed in, register this repository's marketplace and install SQL Apps:

copilot plugin marketplace add microsoft/sql-apps
copilot plugin install sql-apps@sql-apps-skills
copilot plugin list

Inside a Copilot session, the equivalent commands are /plugin marketplace add microsoft/sql-apps, then /plugin install sql-apps@sql-apps-skills. Restart the Copilot App or start a fresh session and confirm that sql-apps is enabled under Customize -> Plugins. This installs seven skills and their launcher, not the application runtime. The repository marketplace is available independently of the pending default Copilot marketplace listing.

To create your first project, use an existing foundation checkout or clone one, then select it in the terminal used to launch your assistant (claude or copilot):

git clone https://github.com/microsoft/sql-apps.git "C:\git\sql-apps"
$env:SQL_APPS_FOUNDATION_HOME = "C:\git\sql-apps"
$env:SQL_APPS_HOME = $env:SQL_APPS_FOUNDATION_HOME
copilot

SQL_APPS_FOUNDATION_HOME selects the project factory and pre-restore setup tooling; SQL_APPS_HOME selects the application. After creating a project, point SQL_APPS_HOME at it and keep the foundation selection.

Generated applications also need @microsoft/sql-apps@0.2.3 from your configured npm feed. Installing the plugin does not make that package available; if the feed cannot resolve it, application restoration is blocked. See the plugin installation guide for checkout-based installation, cloud companion plugins, verification and removal.

Create a project

Keep this foundation checkout as the SQL Apps tool source. Create each application as an independent Git repository under your user project root (by default %USERPROFILE%\SqlAppsProjects on Windows). Git is required; creation stops before changing anything if it is missing.

npm run projects -- create-plan "Equipment Checkout"
npm run projects -- create "Equipment Checkout" --approval <printed-id>

The plan prints every effect (destination, Git repository, local ports, the creation page it opens) and an approval ID; nothing changes until you run the second command with that ID. Creation makes %USERPROFILE%\SqlAppsProjects\equipment-checkout, records it as the active project and prints the command that points SQL_APPS_HOME at it. Run that command, keep SQL_APPS_FOUNDATION_HOME on the foundation, and restart your assistant in the new folder. Creation refuses to merge into an existing folder. Use npm run projects -- root D:\SqlAppsProjects to choose another absolute root, npm run projects -- list to see registered projects, and npm run projects -- open C:\path\to\project to register an existing project.

Open the generated project—not this foundation checkout—in your preferred editor and give your AI assistant access to that project. Ask:

Help me build an equipment checkout app with SQL Apps. Start by asking who will use it and what it should do. Help me run it locally, then make one useful change. Do not deploy it yet.

Replace equipment checkout with your idea. Follow Build your app for the walkthrough, or Get started if you need help installing tools.

The journey is Describe -> Run locally -> Make it yours -> Share optionally.

Already have Node installed? Check your setup from the generated project folder:

npm run setup:check

This npm command requires restored tooling. Before the first restore, use the installed plugin launcher's setup plan --json through its explicit foundation binding; see the setup coordinator. Generated projects do not copy foundation scripts. The check explains missing prerequisites without installing anything. The guides and commands do not require a particular LLM provider. The optional SQL Apps plugin adds project-specific skills in Claude Code and GitHub Copilot. Local work needs only that plugin; its documentation lists the maintained Microsoft SQL, Azure Skills and Azure Cost companion plugins to install when you choose cloud work.

For one connected setup journey, ask your assistant to use the setup coordinator. It plans needed installation, restore, build, workspace and startup steps, then resumes after explicit approvals without repeating current work. It does not generate your domain app, accept licenses or deploy to Azure.

What to expect

Local first, without a preview-access dead end. Prefer the Azure SQL Database container, then Azure SQL Database directly, then SQL Server 2025 Express on supported Windows x64. Node 22 or 24 and a .NET SDK are shared prerequisites; endpoint fallbacks use pinned host DAB without Docker and additionally require .NET and ASP.NET Core 8.0 runtimes, even with a newer SDK. Container and Express routes need no Azure subscription. The container is in private preview: request access and read the container documentation. Missing access offers another explicitly approved database route, never silent data migration. Initial downloads need internet; Docker, SQL installation and your AI provider have their own licensing/access conditions.

Your application. Work with your AI assistant to implement and test its screens and SQL behavior in its generated repository. The project factory creates the runtime foundation, not a finished domain app. The default project has no Todo screen or sample data; examples are selected explicitly.

A useful first result is one real workflow, not a readiness check. Within the first session you should be able to do the one thing your app is for (check out a laptop, record a signup), see it saved in SQL, reload the page and still see it, and see a clear message when a save is invalid. A passing readiness check or a launch URL only means the plumbing works. Run locally explains startup paths, scoped approvals and how to keep your data between sessions.

Sharing is optional. The primary cloud target is Static Web Apps Free, managed Functions and the Azure SQL Database free offer, for yourself or a small team: invite people as owner or member (up to 25) and choose which operations members may call. It can plausibly remain at $0 only within current allowances, and it has no Static Web Apps SLA. When you are ready to share, read Sharing your app and Costs and growth.

Find your next step

I want to... Start here
Set up my computer Get started
Turn an idea into an app Build your app
Try the included example Todo reference
Start, stop or resume locally Run locally
Understand cloud costs Costs and growth
Share with other people Sharing your app
Find detailed commands or contribute Documentation index

Under the hood, SQL Apps uses TypeScript and Azure SQL Database. Local development uses Data API builder and a sign-in gateway; the primary personal cloud profile uses a managed Functions API with an explicit stored-procedure allowlist. If your app later needs file storage or background jobs, add them with maintained Azure skills rather than SQL Apps.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos must follow the Microsoft Trademark and Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos is subject to those third parties' policies.

License

MIT

For contributions and help, see Contributing, Support and Security.

About

SQL Apps gives you a working application foundation and guides for creating your own screens, data and workflows with the AI assistant of your choice. You can start with an idea rather than a framework choice.

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages