This feature will guide a user with setting up a new web application for local web development with just a few keystrokes and mouse-clicks:
Simply specify a name for your new web application, specify a database location, and a destination folder on your computer that will contain the newly created application. Once that information has been specified, pressing the "Scaffold App" button will:
Copy the LymeTemplate Web Application Template source code to the destination folder.
Generate an empty file called README.html, which is where you can place documentation for your own project.
Generate an empty LICENSE file where you can specify the usage terms for your application.
Create a new database on the specified SQL Server instance and create any LymeTemplate core functionality tables and seeded data.
Create an empty Git repository for management of your project's source control.
Replace any instance of the text "LymeTemplate" in your application with the name of your new application. Text replacement will pay attention to all the text formats that would likely to exist. For example the following text replacements would happen changing LymeTemplate to MyCompany in any text file, folder or file name:
Case Style
Text Example
Replacement Text
Sentence
Lyme template
My company
Title
Lyme Template
My Company
Pascal
LymeTemplate
MyCompany
Camel
lymeTemplate
myCompany
Snake
lyme-template
my-company
Uppercase
LYMETEMPLATE
MYCOMPANY
Lowercase
lymetemplate
mycompany
Instructions for Use
Enter the name for the new application. I usually name the application after the entity name whose name brands the application. For purposes of this documentation, I will name my app "My Company".
Specify a Data Connection. This step requires for a SQL Server instance to be available with permissions set to allow for the creation of a database or an empty database needs to have already been created and write access permitted to that database.
Select the output folder to store your web application files on your local computer. For this example, we will use C:\git.
Press the Scaffold App.
Sample Log Output from a Scaffold App Operation
Creating folder c:\git\mycompany
Creating empty license, readme and gitignore files.
Creating Run.bat batch file and bash scripts.
Installing LymeTemplate project folders.
Adjusting namespaces...
Creating database named MyCompany on .\SQLEXPRESS.
Database created. Pausing for 5 seconds to SQL Server a moment to breathe...
Creating LymeTemplate tables and stored procedures.
Initializing Data Directories...
Configuring for IIS Express default usage.
Updating WebApi Connection String
Skipping the creation of the git repo for now...
Done!
After creating your application:
Configure Azure Entra ID credentials for your organization - In order to protect resources in your application, users must log in using the widely used Microsoft Azure Cloud platform's user authentication system branded by Microsoft as Azure Entra ID. It provides password management as well as Multi-factor authentication (MFA) security for your application. Performing this step may require help from your IT Administrator, but a walk-through guide for configuring Azure Entra ID is included in the Getting Started section. Once Entra ID is configured in the Azure Portal, click the "Configure Entra ID" button to enter your domain, tenant ID, App Application ID and API Application ID.
Once you have configured Azure Entra ID, you need to register you Entra ID Username with the newly created MyCompany app. Use the "Add User" button to perform this task.
At this point, clicking the "Run App" button will launch two command line windows. One will be for the API, the other for the front end application. This can take a few minutes for your first time running the application as the yarn process takes a while to initially download and install Javascript / Node dependencies for the front-end application. Subsequent clicks of the "Run App" button will prove to be more performant because of caching that happens during the first build. A browser window will open when the app is ready.
Below is a screenshot of what a newly scaffolded application looks like from the output of our example:
For more information about LymeTemplate and what is included in a fresh LymeTemplate installation, see the LymeTemplate appendix.
