-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🧑💻Added README for templated solutions.
- Loading branch information
1 parent
9902f45
commit 1aa03dd
Showing
5 changed files
with
74 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# CleanArchitecture | ||
|
||
The project was generated using the [Clean.Architecture.Solution.Template](https://github.com/jasontaylordev/CleanArchitecture) version 8.0.0-preview.6.7. | ||
|
||
## Build | ||
|
||
Run `dotnet build -tl` to build the solution. | ||
|
||
## Run | ||
|
||
To run the web application: | ||
|
||
```bash | ||
cd .\src\Web\ | ||
dotnet watch run | ||
``` | ||
|
||
Navigate to https://localhost:5001. The application will automatically reload if you change any of the source files. | ||
|
||
## Code Scaffolding | ||
|
||
The template includes support to scaffold new commands and queries. | ||
|
||
Start in the `.\src\Application\` folder. | ||
|
||
Create a new command: | ||
|
||
``` | ||
dotnet new ca-usecase --name CreateTodoList --feature-name TodoLists --usecase-type command --return-type int | ||
``` | ||
|
||
Create a new query: | ||
|
||
``` | ||
dotnet new ca-usecase -n GetTodos -fn TodoLists -ut query -rt TodosVm | ||
``` | ||
|
||
If you encounter the error *"No templates or subcommands found matching: 'ca-usecase'."*, install the template and try again: | ||
|
||
```bash | ||
dotnet new install Clean.Architecture.Solution.Template::8.0.0-preview.6.7 | ||
``` | ||
|
||
## Test | ||
|
||
The solution contains unit, integration, and acceptance tests. | ||
|
||
To run the unit and integration tests (excluding acceptance tests): | ||
```bash | ||
dotnet test --filter "FullyQualifiedName!~AcceptanceTests" | ||
``` | ||
|
||
To run the acceptance tests, first start the application: | ||
|
||
```bash | ||
cd .\src\Web\ | ||
dotnet run | ||
``` | ||
|
||
Then, in a new console, run the tests: | ||
```bash | ||
cd .\src\Web\ | ||
dotnet test | ||
``` | ||
|
||
## Help | ||
To learn more about the template go to the [project website](https://github.com/JasonTaylorDev/CleanArchitecture). Here you can find additional guidance, request new features, report a bug, and discuss the template with other users. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters