diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..3ef416e --- /dev/null +++ b/.dockerignore @@ -0,0 +1,496 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from `dotnet new gitignore` + +# dotenv files +.env + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Ww][Ii][Nn]32/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET +project.lock.json +project.fragment.lock.json +artifacts/ + +# Tye +.tye/ + +# ASP.NET Scaffolding +ScaffoldingReadMe.txt + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.tlog +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Coverlet is a free, cross platform Code Coverage Tool +coverage*.json +coverage*.xml +coverage*.info + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio 6 auto-generated project file (contains which files were open etc.) +*.vbp + +# Visual Studio 6 workspace and project file (working project files containing files to include in project) +*.dsw +*.dsp + +# Visual Studio 6 technical files +*.ncb +*.aps + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# Visual Studio History (VSHistory) files +.vshistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ + +# Fody - auto-generated XML schema +FodyWeavers.xsd + +# VS Code files for those working on multiple tools +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +*.code-workspace + +# Local History for Visual Studio Code +.history/ + +# Windows Installer files from build outputs +*.cab +*.msi +*.msix +*.msm +*.msp + +# JetBrains Rider +*.sln.iml +.idea + +## +## Visual studio for Mac +## + + +# globs +Makefile.in +*.userprefs +*.usertasks +config.make +config.status +aclocal.m4 +install-sh +autom4te.cache/ +*.tar.gz +tarballs/ +test-results/ + +# Mac bundle stuff +*.dmg +*.app + +# content below from: https://github.com/github/gitignore/blob/master/Global/macOS.gitignore +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +# content below from: https://github.com/github/gitignore/blob/master/Global/Windows.gitignore +# Windows thumbnail cache files +Thumbs.db +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk + +# Vim temporary swap files +*.swp + +# Custom ignores + +.template.config +assets +requests +LICENSE +README.md +**/*.sqlite + +**/Dockerfile* +**/docker-compose* \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json index 85dbb6d..47f84e4 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,7 +1,7 @@ { "rest-client.environmentVariables": { "$shared": { - "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiTGlvciIsImZhbWlseV9uYW1lIjoiRGFnYW4iLCJlbWFpbCI6Imxpb3JAZGFnYW4uY29tIiwiaWQiOiJhYWU5M2JmNS05ZTNjLTQ3YjMtYWFjZS0zMDM0NjUzYjZiYjIiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3JvbGUiOiJBZG1pbiIsInBlcm1pc3Npb25zIjpbInNldDpyZW1pbmRlciIsImdldDpyZW1pbmRlciIsImRpc21pc3M6cmVtaW5kZXIiLCJkZWxldGU6cmVtaW5kZXIiLCJjcmVhdGU6c3Vic2NyaXB0aW9uIiwiZGVsZXRlOnN1YnNjcmlwdGlvbiIsImdldDpzdWJzY3JpcHRpb24iXSwiZXhwIjoxNzAzNzY0ODA4LCJpc3MiOiJSZW1pbmRlclNlcnZpY2UiLCJhdWQiOiJSZW1pbmRlclNlcnZpY2UifQ.hY4F9MC3jDF-xieCnGtmYrnf1--crcnlmHSAE4_3z2I", + "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiTGlvciIsImZhbWlseV9uYW1lIjoiRGFnYW4iLCJlbWFpbCI6Imxpb3JAZGFnYW4uY29tIiwiaWQiOiJhYWU5M2JmNS05ZTNjLTQ3YjMtYWFjZS0zMDM0NjUzYjZiYjIiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3JvbGUiOiJBZG1pbiIsInBlcm1pc3Npb25zIjpbInNldDpyZW1pbmRlciIsImdldDpyZW1pbmRlciIsImRpc21pc3M6cmVtaW5kZXIiLCJkZWxldGU6cmVtaW5kZXIiLCJjcmVhdGU6c3Vic2NyaXB0aW9uIiwiZGVsZXRlOnN1YnNjcmlwdGlvbiIsImdldDpzdWJzY3JpcHRpb24iXSwiZXhwIjoxNzA0MTM4MzQ4LCJpc3MiOiJSZW1pbmRlclNlcnZpY2UiLCJhdWQiOiJSZW1pbmRlclNlcnZpY2UifQ.g6pQDvZD8-9BmXLRWyKAaD_wTf632GIGNApCCnYV6Jc", "userId": "aae93bf5-9e3c-47b3-aace-3034653b6bb2", "subscriptionId": "c8ee11f0-d4bb-4b43-a448-d511924b520e", "reminderId": "08233bb1-ce29-49e2-b346-5f8b7cf61593" diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..f9b259f --- /dev/null +++ b/Dockerfile @@ -0,0 +1,23 @@ +FROM mcr.microsoft.com/dotnet/sdk:8.0 AS build +WORKDIR /src +COPY ["src/CleanArchitecture.Api/CleanArchitecture.Api.csproj", "CleanArchitecture.Api/"] +COPY ["src/CleanArchitecture.Application/CleanArchitecture.Application.csproj", "CleanArchitecture.Application/"] +COPY ["src/CleanArchitecture.Domain/CleanArchitecture.Domain.csproj", "CleanArchitecture.Domain/"] +COPY ["src/CleanArchitecture.Contracts/CleanArchitecture.Contracts.csproj", "CleanArchitecture.Contracts/"] +COPY ["src/CleanArchitecture.Infrastructure/CleanArchitecture.Infrastructure.csproj", "CleanArchitecture.Infrastructure/"] +COPY ["Directory.Packages.props", "./"] +COPY ["Directory.Build.props", "./"] +RUN dotnet restore "CleanArchitecture.Api/CleanArchitecture.Api.csproj" +COPY . ../ +WORKDIR /src/CleanArchitecture.Api +RUN dotnet build "CleanArchitecture.Api.csproj" -c Release -o /app/build + +FROM build AS publish +RUN dotnet publish --no-restore -c Release -o /app/publish + +FROM mcr.microsoft.com/dotnet/aspnet:8.0 +ENV ASPNETCORE_HTTP_PORTS=5001 +EXPOSE 5001 +WORKDIR /app +COPY --from=publish /app/publish . +ENTRYPOINT ["dotnet", "CleanArchitecture.Api.dll"] \ No newline at end of file diff --git a/README.md b/README.md index a059223..91b4d3f 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,13 @@ dotnet new clean-arch -o CleanArchitecture - [Subscriptions](#subscriptions) - [Reminders](#reminders) - [Getting Started 🏃](#getting-started-) + - [Clone the repository](#clone-the-repository) + - [Run the service](#run-the-service) + - [Run the service using Docker](#run-the-service-using-docker) + - [Run the service using the .NET CLI](#run-the-service-using-the-net-cli) + - [Generate a token](#generate-a-token) + - [Create a subscription](#create-a-subscription) + - [Create a reminder](#create-a-reminder) - [Folder Structure 📁](#folder-structure-) - [Authorization 🔐](#authorization-) - [Authorization Types](#authorization-types) @@ -96,74 +103,136 @@ Users with a pro subscription do not have a daily limit on the number of reminde # Getting Started 🏃 -1. Run the project `dotnet run --project src/CleanArchitecture.Api` -1. Navigate to `requests/Tokens/GenerateToken.http` and generate a token. +## Clone the repository - ```yaml - POST {{host}}/tokens/generate - Content-Type: application/json - ``` +```shell +git clone https://github.com/amantinband/clean-architecture +``` - ```http - { - "Id": "bae93bf5-9e3c-47b3-aace-3034653b6bb2", - "FirstName": "Amichai", - "LastName": "Mantinband", - "Email": "amichai@mantinband.com", - "Permissions": [ - "set:reminder", - "get:reminder", - "dismiss:reminder", - "delete:reminder", - "create:subscription", - "delete:subscription", - "get:subscription" - ], - "Roles": [ - "Admin" - ] - } - ``` +## Run the service - > Note: Since most systems use an external identity provider, this project uses a simple token generator endpoint that generates a token based on the details you provide. This is a simple way to generate a token for testing purposes and is closer to how your system will likely be designed when using an external identity provider. +### Run the service using Docker -1. Create a subscription +```shell +docker compose up +``` - ```yaml - POST {{host}}/users/{{userId}}/subscriptions - Content-Type: application/json - Authorization: Bearer {{token}} - ``` +### Run the service using the .NET CLI - ```http - { - "SubscriptionType": "Basic" - } - ``` +```shell +dotnet run --project src/CleanArchitecture.Api +``` - > Note: To replace http file variables `{{variableName}}`, you can either: - > 1. Use the [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) extension for VS Code + update the values under ".vscode/settings.json". This will update the value for all http files. - > 1. Define the variables in the http file itself: - > ```yaml - > @host = http://localhost:5001 - > @userId = bae93bf5-9e3c-47b3-aace-3034653b6bb2 - > ``` - > 1. Replace the variables manually. - -1. Create a reminder - - ```yaml - POST {{host}}/users/{{userId}}/subscriptions/{{subscriptionId}}/reminders - Content-Type: application/json - Authorization: Bearer {{token}} - ``` +## Generate a token - ```http - { - "text": "let's do it", - "dateTime": "2025-2-26" - } - ``` +Navigate to `requests/Tokens/GenerateToken.http` and generate a token. + +> Note: Since most systems use an external identity provider, this project uses a simple token generator endpoint that generates a token based on the details you provide. This is a simple way to generate a token for testing purposes and is closer to how your system will likely be designed when using an external identity provider. + +```yaml +POST {{host}}/tokens/generate +Content-Type: application/json +``` + +```http +{ + "Id": "bae93bf5-9e3c-47b3-aace-3034653b6bb2", + "FirstName": "Amichai", + "LastName": "Mantinband", + "Email": "amichai@mantinband.com", + "Permissions": [ + "set:reminder", + "get:reminder", + "dismiss:reminder", + "delete:reminder", + "create:subscription", + "delete:subscription", + "get:subscription" + ], + "Roles": [ + "Admin" + ] +} +``` + +> ### NOTE: Replacing http file variables (`{{variableName}}`) +> +> #### Option 1 (recommended) - Using the [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) extension for VS Code +> +> Use the [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) extension for VS Code + update the values under [.vscode/settings.json](.vscode/settings.json). This will update the value for all http files. +> +> ```json +> { +> "rest-client.environmentVariables": { +> "$shared": { // these will be shared across all http files, regardless of the environment +> "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiTGlvciIsImZhbWlseV9uYW1lIjoiRGFnYW4iLCJlbWFpbCI6Imxpb3JAZGFnYW4uY29tIiwiaWQiOiJhYWU5M2JmNS05ZTNjLTQ3YjMtYWFjZS0zMDM0NjUzYjZiYjIiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3JvbGUiOiJBZG1pbiIsInBlcm1pc3Npb25zIjpbInNldDpyZW1pbmRlciIsImdldDpyZW1pbmRlciIsImRpc21pc3M6cmVtaW5kZXIiLCJkZWxldGU6cmVtaW5kZXIiLCJjcmVhdGU6c3Vic2NyaXB0aW9uIiwiZGVsZXRlOnN1YnNjcmlwdGlvbiIsImdldDpzdWJzY3JpcHRpb24iXSwiZXhwIjoxNzA0MTM0MTIzLCJpc3MiOiJSZW1pbmRlclNlcnZpY2UiLCJhdWQiOiJSZW1pbmRlclNlcnZpY2UifQ.wyvn9cq3ohp-JPTmbBd3G1cAU1A6COpiQd3C_e_Ng5s", +> "userId": "aae93bf5-9e3c-47b3-aace-3034653b6bb2", +> "subscriptionId": "c8ee11f0-d4bb-4b43-a448-d511924b520e", +> "reminderId": "08233bb1-ce29-49e2-b346-5f8b7cf61593" +> }, +> "dev": { // when the environment is set to dev, these values will be used +> "host": "http://localhost:5001", +> }, +> "prod": { // when the environment is set to prod, these values will be used +> "host": "http://your-prod-endpoint.com", +> } +> } +>} +> ``` +> +> #### Options 2 - Defining the variables in the http file itself +> +> Define the variables in the http file itself. This will only update the value for the current http file. +> +> ```yaml +> @host = http://localhost:5001 +> +> POST {{host}}/tokens/generate +> ``` +> +> #### Option 3 - Manually +> +> Replace the variables manually. +> +> ```yaml +> POST {{host}}/tokens/generate +> ``` +> +> 👇 +> +> ```yaml +> POST http://localhost:5001/tokens/generate +> ``` +> + +## Create a subscription + +```yaml +POST {{host}}/users/{{userId}}/subscriptions +Content-Type: application/json +Authorization: Bearer {{token}} +``` + +```http +{ + "SubscriptionType": "Basic" +} +``` + +## Create a reminder + +```yaml +POST {{host}}/users/{{userId}}/subscriptions/{{subscriptionId}}/reminders +Content-Type: application/json +Authorization: Bearer {{token}} +``` + +```http +{ + "text": "let's do it", + "dateTime": "2025-2-26" +} +``` # Folder Structure 📁 diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..26a3795 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,15 @@ +version: '3.8' + +services: + api: + container_name: clean-architecture-api + build: + context: . + dockerfile: Dockerfile + ports: + - "5001:5001" + environment: + - ASPNETCORE_ENVIRONMENT=Development + restart: on-failure + volumes: + - ./src/CleanArchitecture.Api/CleanArchitecture.sqlite:/app/CleanArchitecture.sqlite \ No newline at end of file diff --git a/src/CleanArchitecture.Api/CleanArchitecture.Api.csproj b/src/CleanArchitecture.Api/CleanArchitecture.Api.csproj index b1afcbd..64b7c51 100644 --- a/src/CleanArchitecture.Api/CleanArchitecture.Api.csproj +++ b/src/CleanArchitecture.Api/CleanArchitecture.Api.csproj @@ -1,10 +1,6 @@  - net8.0 - enable - enable - true true 36d3aabc-1075-47d7-9b3b-c1feebf8f3bd diff --git a/src/CleanArchitecture.Api/Properties/launchSettings.json b/src/CleanArchitecture.Api/Properties/launchSettings.json index ff4178e..366a325 100644 --- a/src/CleanArchitecture.Api/Properties/launchSettings.json +++ b/src/CleanArchitecture.Api/Properties/launchSettings.json @@ -36,6 +36,16 @@ "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" } + }, + "Docker": { + "commandName": "Docker", + "launchBrowser": false, + "launchUrl": "{Scheme}://{ServiceHost}:{ServicePort}/swagger", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development", + }, + "publishAllPorts": true, + "httpPort": 5001, } } -} +} \ No newline at end of file