Skip to content

Commit

Permalink
FEAT: Completed rebranding from DCSL GuideSmiths to One Beyond.
Browse files Browse the repository at this point in the history
FEAT: Completed Readme.
CHORE: Added banner and logo.
  • Loading branch information
CesarD committed Sep 2, 2022
1 parent 07405a5 commit 85a4980
Show file tree
Hide file tree
Showing 13 changed files with 45 additions and 28 deletions.
2 changes: 1 addition & 1 deletion PublishPackage.cmd
Original file line number Diff line number Diff line change
@@ -1 +1 @@
dotnet nuget push --source "guidesmiths" --api-key az %1
dotnet nuget push %1 --api-key %2 --source "nuget.org"
53 changes: 35 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,41 @@
# Monaco - .NET Template
![Nombre1](monaco-transp.png)
-

# Introduction
Monaco is a .NET solution template that provides the scaffolding for a .NET 6 solution based on the Vertical Slice Architecture. It ships the most basic structure required to run a REST API with EF Core with a rich model Domain.
Monaco is a .NET solution template that provides the scaffolding for a .NET solution based on the [Vertical Slices Architecture](https://www.youtube.com/watch?v=SUiWfhAhgQw).

It ships the most basic structure required to run a REST API with EF Core and a rich model Domain, along with unit tests to cover the existing boilerplate.

It also provides some basic business components as example of real life implementation logic.

# Getting Started
TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
1. Installation process
2. Software dependencies
3. Latest releases
4. API references

# Build and Test
TODO: Describe and show how to build your code and run the tests.

# Contribute
TODO: Explain how other users and developers can contribute to make your code better.

If you want to learn more about creating good readme files then refer the following [guidelines](https://docs.microsoft.com/en-us/azure/devops/repos/git/create-a-readme?view=azure-devops). You can also seek inspiration from the below readme files:
- [ASP.NET Core](https://github.com/aspnet/Home)
- [Visual Studio Code](https://github.com/Microsoft/vscode)
- [Chakra Core](https://github.com/Microsoft/ChakraCore)

#### Supported .NET version:

6.0

#### Installation

`dotnet new --install Monaco.Template.Solution`

#### Uninstalling

`dotnet new --uninstall Monaco.Template.Solution`

#### How to create a Monaco based solution

`dotnet new monaco-solution -n MyFirstSolution`

This will create a folder named `MyFirstSolution`, which will contain a structure of directories prefixed with the name as part of the namespace declaration. The resulting solution will include the default layout and all the files required to run the application.

From there, is enough to configure `appsettings.json` with the required settings and run the app.

#### Getting help about template's options

`dotnet new monaco-solution --help`

#### Visual Studio support

Monaco provides support for generating the solution and projects from Visual Studio as well as providing the UI interface for configuring the project generation options.

However, it's not recommended to use VS for generating new solutions. Monaco provides a default layout for the solution with the projects organized in different folders and some solution files already included in it, but this default layout from the template is ignored by VS, which also creates an additional level of folders in the generated folder. Because of these behaviors we strongly recommend using the console for running Monaco and generating any new solutions.
Binary file added monaco-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added monaco-solid.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added monaco-transp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion nuget.config
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
<configuration>
<packageSources>
<clear />
<add key="guidesmiths" value="https://pkgs.dev.azure.com/guidesmiths/_packaging/guidesmiths/nuget/v3/index.json" />
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
</packageSources>
</configuration>
Binary file removed src/Content/.template.config/icon.jpg
Binary file not shown.
Binary file modified src/Content/.template.config/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/Content/.template.config/template.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "http://json.schemastore.org/template",
"author": "DCSL GuideSmiths",
"author": "One Beyond",
"classifications": [ "Web", "Solution" ],
"name": "Monaco Solution Template",
"description": "Solution template for .NET projects",
Expand Down
4 changes: 2 additions & 2 deletions src/Content/Monaco.Template.Api/appsettings.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@
"SwaggerUIAppName": "Monaco Template API - Swagger UI",
"Title": "Monaco Template API",
"Description": "Monaco Template - API",
"ContactName": "DCSL",
"ContactName": "One Beyond",
"ContactEmail": "",
"TermsOfService": "https://www.dcsl.com"
"TermsOfService": "https://www.one-beyond.com"
},

"ApplicationInsights": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
<FileVersion>0.0.1.0-alpha1</FileVersion>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Version>0.0.1-alpha1</Version>
<Authors>DCSL GuideSmiths</Authors>
<Company>DCSL GuideSmiths</Company>
<Authors>One Beyond</Authors>
<Company>One Beyond</Company>
<PackageProjectUrl></PackageProjectUrl>
<RepositoryUrl></RepositoryUrl>
</PropertyGroup>
Expand Down
2 changes: 1 addition & 1 deletion src/Content/realm-export-template.json
Original file line number Diff line number Diff line change
Expand Up @@ -1590,7 +1590,7 @@
},
"smtpServer": {
"host": "localhost",
"from": "sso@dcsl.com",
"from": "sso@one-beyond.com",
"starttls": "",
"auth": "",
"ssl": ""
Expand Down
4 changes: 2 additions & 2 deletions src/Monaco.Template.nuspec
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
<metadata>
<id>Monaco.Template.Solution.nuspec</id>
<id>Monaco.Template.Solution</id>
<version>0.0.1-alpha1</version>
<description>
Solution Template for .NET projects
</description>
<authors>DCSL GuideSmiths</authors>
<authors>One Beyond</authors>
<license type="expression">ISC</license>
<packageTypes>
<packageType name="Template" />
Expand Down

0 comments on commit 85a4980

Please sign in to comment.