generated from nventive/Template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b494009
commit 273cceb
Showing
6 changed files
with
170 additions
and
148 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| #name: Publish | ||
| #on: | ||
| # push: | ||
| # tags: | ||
| # - v* | ||
| # | ||
| #jobs: | ||
| # build: | ||
| # runs-on: ubuntu-latest | ||
| # | ||
| # steps: | ||
| # - name: Checkout code | ||
| # uses: actions/checkout@v3 | ||
| # | ||
| # - name: Build NuGet Package | ||
| # run: nuget pack . -Version ${GITHUB_REF#refs/tags/v} -OutputDirectory ./artifacts | ||
| # | ||
| # - name: Publish NuGet package | ||
| # run: nuget push ./artifacts/nventive.Cloud.Templates.Aspire.*.nupkg ${{ secrets.NUGET_API_KEY }} -Source https://api.nuget.org/v3/index.json |
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,134 @@ | ||
| # Placeholder | ||
|
|
||
| {Project tag line} | ||
|
|
||
| {Small description of the purpose of the project} | ||
|
|
||
| [](LICENSE) | ||
|
|
||
| ## Getting Started | ||
|
|
||
| The main prerequisites for a developer setup are: | ||
| - either Linux (including WSL) or macOS as OS; | ||
| - the Nix package manager with flakes enabled; | ||
| - direnv and nix-direnv; | ||
| - Docker; | ||
| - Visual Studio Code with the C# DevKit extension for debugging; | ||
| - an Azure account to deploy and run in the cloud. | ||
|
|
||
| Precise installations instructions are as follow: | ||
|
|
||
| ### For WSL Users | ||
| - If you’re using Docker Desktop, remember to [enable it in your WSL distro](https://docs.docker.com/desktop/wsl/#enabling-docker-support-in-wsl-2-distros) | ||
| - VS Code extensions must be activated in WSL. | ||
| - The ASP.NET Core developement certificate installed in WSL must be trusted in your Windows browser. | ||
|
|
||
| Then you need to trust the ASP.NET Core development certificate. | ||
|
|
||
| 1. Install the .NET SDK in Windows [whichever way you want](https://learn.microsoft.com/en-us/dotnet/core/install/windows). | ||
| 1. Install and activate the ASP.NET Core development certificate (`[password]` being any password you’ll remember in the next minute). In Windows: | ||
| ```console | ||
| dotnet dev-certs https --clean | ||
| dotnet dev-certs https --trust | ||
| dotnet dev-certs https -ep https.pfx -p [password] | ||
| ``` | ||
| 3. Restart your browser to make sure it trusts the new certificate. | ||
| 3. Import the certificate in WSL and trust it for inter-service communications (`[path]` being the path to the windows directory you executed the previous commands, and `[password]` being the password entered previously): | ||
| ```console | ||
| sudo apt install dotnet-sdk-8.0 | ||
| dotnet dev-certs https --clean --import /mnt/c/[path]/https.pfx --password [password] | ||
| sudo -E dotnet dev-certs https -ep /usr/local/share/ca-certificates/aspnet/https.crt --format PEM | ||
| sudo update-ca-certificates | ||
| ``` | ||
|
|
||
| ### For macOS and straight Linux users | ||
|
|
||
| ASP.NET Core development certificate is more simple. | ||
|
|
||
| 1. [Install a .NET SDK](https://learn.microsoft.com/en-us/dotnet/core/install/). | ||
| 2. Install and activate the ASP.NET Core development certificate | ||
| ```console | ||
| dotnet dev-certs https --clean | ||
| dotnet dev-certs https --trust | ||
| ``` | ||
|
|
||
| ### For all OSes: install Nix, direnv | ||
|
|
||
| Use the [Determinate Nix installer](https://github.com/DeterminateSystems/nix-installer): | ||
| ```console | ||
| curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install | ||
| ``` | ||
|
|
||
| Follow any instructions, including those necessary to get nix in path. | ||
|
|
||
| 1. Install direnv. | ||
| ```console | ||
| nix profile install nixpkgs#nix-direnv | ||
| ``` | ||
| 2. [Hook direnv into your shell](https://direnv.net/docs/hook.html). | ||
|
|
||
| > For bash this means adding the following line in your `~/.bashrc`: | ||
| > ```bash | ||
| > eval "$(direnv hook bash)" | ||
| > ``` | ||
| > For zsh (macOS), the file is `~/.zshrc` and the line is | ||
| > ```zsh | ||
| > eval "$(direnv hook zsh)" | ||
| > ``` | ||
| 3. Don’t forget to reload your shell | ||
| > ```console | ||
| > source ~/.bashrc | ||
| > ``` | ||
| > | ||
| > or | ||
| > ```console | ||
| > source ~/.zshrc | ||
| > ``` | ||
| 4. Install nix-direnv in your user Nix profile and hook it up to direnv. | ||
| > ```console | ||
| > nix profile install nixpkgs#nix-direnv | ||
| > source $HOME/.nix-profile/share/nix-direnv/direnvrc | ||
| > ``` | ||
| ### Start for real | ||
| 1. Get this repository’s content | ||
| ```console | ||
| git checkout [ProjectRepository] | ||
| ``` | ||
| 4. Start VS Code. NB: it has to be started this way to ensure the correct .NET frawework is found and debugging works. | ||
| ```console | ||
| just code | ||
| ``` | ||
|
|
||
| To get a list of other recipes: | ||
| ```console | ||
| just --list | ||
| ``` | ||
|
|
||
| Further instructions are in the `README` of your new project. | ||
|
|
||
| ## Features | ||
|
|
||
| {More details/listing of features of the project} | ||
|
|
||
| ## Breaking Changes | ||
|
|
||
| Please consult [BREAKING_CHANGES.md](BREAKING_CHANGES.md) for more information about version | ||
| history and compatibility. | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the Apache 2.0 license - see the | ||
| [LICENSE](LICENSE) file for details. | ||
|
|
||
| ## Contributing | ||
|
|
||
| Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the process for | ||
| contributing to this project. | ||
|
|
||
| Be mindful of our [Code of Conduct](CODE_OF_CONDUCT.md). |
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