Quick Project Setup
Now that your environment is ready, this step shows you how to create your first Velaptor project.
Using a project template is the fastest and most recommended approach to creating a Velaptor project. This guide will demonstrate how to use the dotnet CLI tool to create a Velaptor project, similar to creating other types of .NET projects with built-in templates.
If you are already familiar with the dotnet CLI tool, creating a project using a template will be straightforward.
Once your project is created, continue through the quick start sequence. If you are skipping the manual setup page, go directly to the Adding Content page.
Go to the EmptyProject guide project to see the source code for a fully working example of this guide.
Step 1: Install Velaptor Project Templates
To install the latest version of the Velaptor project templates, run the following command in your terminal:
If you are new to development, a terminal is the app where you type commands:
- Windows: Command Prompt or PowerShell
- Linux: Terminal
dotnet new install KinsonDigital.VelaptorTemplates
If you prefer to install a specific version of the templates, use the command below, replacing 1.0.0 with your desired version number:
dotnet new install KinsonDigital.VelaptorTemplates::1.0.0
To uninstall the project templates, execute the following command:
dotnet new uninstall KinsonDigital.VelaptorTemplates
Step 2: Create Velaptor Project
With the project templates installed, you can easily create a Velaptor project. To see a list of Velaptor projects that you can create, run the following command:
dotnet new details KinsonDigital.VelaptorTemplates
You will receive a list of short names that you can use to create your project.
To create a simple, empty Velaptor project with the name QuickStart, run the following command:
dotnet new VelEmpty --name QuickStart
That's it! You now have a Velaptor project created using a project template.
In the next quick start step, you will add image content to this project.