Get Started with LymeStack
Hopefully within the next hour, we'll have you up and running with a working app on your local computer.
Introduction
Welcome to our getting started guide where we hope you find it as easy as possible to get started with LymeStack on your local machine. This guide is broken into 5 sections:
- Download the Tools - An installer program makes it easy to get LymeTools up and running.
- Install and Run the Tools - After downloading, install and run the LymeTools program.
- Install Prerequisites - LymeTools requires a few tools to be installed prior to scaffolding an app.
- Configure Azure - Follow this guide to configure Azure Entra ID for your organization.
- Scaffold Your First App - Once Azure and prerequisite setup is out of the way, get a new app up and running in a couple of minutes.
- Scaffold Your First Feature - Scaffold a new feature into your newly scaffolded app. There are a few ways to do it.
Step 2 - Install & Run LymeTools
After downloading the tools, simply open the installer program. We are currently working on correcting this issue with Microsoft, but you will receive some security prompts where you will need to confirm that it is safe to install.
Step 3 - Install Prerequisite Software
LymeTools requires a few tools to be installed prior to scaffolding an app.
Prerequisite List:
-
SQL Server (Express, Developer or Docker Instance):
https://www.microsoft.com/en-us/sql-server/sql-server-downloads -
7-Zip (optional, but highly recommended):
https://www.7-zip.org/download.html -
NodeJs:
https://www.nodejs.org -
Dotnet Typegen:
At the command prompt:dotnet tool install --global dotnet-typegen --version 5.0.1 -
Yarn: (after installing NodeJS)
At the command prompt:npm install -g yarn
Step 4 - Configure Azure Entra ID
Disclaimer: Admittedly configuring Azure for LymeStack is the most painful part of the setup. Moving forward, we hope to automate as much of this as possible. For now, this guide should work. Note: You need to have set up an Azure account and have access to the Azure Portal to continue with this guide.
