Voyager

A cli tool helps you create new projects with a template.

Installation

Requirements:

1. .NET 9 SDK

Run the following command to install this tool:

dotnet tool install --global Aiursoft.Voyager

Usage

After getting the binary, run it directly in the terminal.

anduin@anduin-lunar:~/Temp$ ~/.dotnet/tools/voyager new

Description:
  Create a new project based on a template.

Usage:
  voyager new [options]

Options:
  --path <path>                                               The path to the project. [default: .]
  -t, --template-short-name <template-short-name> (REQUIRED)  The short name of the template to use. Run `voyager list` to see all available templates.
  -p, --templates-endpoint <templates-endpoint>               The endpoint to fetch templates from. [default: https://gitlab.aiursoft.cn/aiursoft/voyager/-/raw/master/templates.json]
  -n, --name <name>                                           The name of the new project. [default: Temp]
  -v, --verbose                                               Show detailed log
  -?, -h, --help                                              Show help and usage information

To create a new project, run the following command:

anduin@anduin-lunar:~/Temp$ ~/.dotnet/tools/voyager new -t web-app-simple

To list all available templates, run the following command:

anduin@anduin-lunar:~/Temp$ ~/.dotnet/tools/voyager list
Template 'class-library' from Aiursoft/GitRunner:
  - Full name: Class Library, with unit test project

Template 'dotnet-cli-tool-simple' from Aiursoft/Httping:
  - Full name: .NET CLI global CLI application, single command.

Template 'dotnet-cli-tool-configuration' from Anduin/HappyRecorder:
  - Full name: .NET CLI global CLI application, multiple commands, with configuration system

Template 'dotnet-cli-tool-service' from Aiursoft/Static:
  - Full name: .NET CLI global CLI application, running with host service

Template 'web-app-simple' from Aiursoft/Tracer:
  - Full name: ASP.NET Core Web Application, with front-end packages and simple back-end

Template 'web-app-database-crud' from Anduin/FlyClass:
  - Full name: ASP.NET Core Web Application, with database and CRUD operations

Template 'web-app-storage' from Aiursoft/AiurDrive:
  - Full name: ASP.NET Core Web Application, with user uploading and stroage service

Template 'web-app-client-sdk' from Aiursoft/StatHub:
  - Full name: ASP.NET Core Web Application, with client side application and SDK

Run locally

Requirements about how to run

1. .NET 9 SDK
2. Execute dotnet run to run the app

Run in Microsoft Visual Studio

1. Open the .sln file in the project path.
2. Press F5.

How to contribute

There are many ways to contribute to the project: logging bugs, submitting pull requests, reporting issues, and creating suggestions.

Even if you with push rights on the repository, you should create a personal fork and create feature branches there when you need them. This keeps the main repository clean and your workflow cruft out of sight.

We're also interested in your feedback on the future of this project. You can submit a suggestion or feature request through the issue tracker. To make this process more effective, we're asking that these include more information to help define them more clearly.