Release/v1.0.0

.github/workflows/build-commerceapi.yml

@@ -0,0 +1,59 @@
+name: Jhoose Commerce API Build
+
+on:
+  push:
+    branches: [ main, release/* ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+env:
+  BUILD_NO: 1.0.0.${{ github.run_number }}  
+  BUILD_NO_PRE: 1.0.0-rc.${{ github.run_number }} 
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: | 
+          8.0.x
+          9.0.x
+          10.0.x
+
+    - name: Configure Source
+      working-directory: ./src/Jhoose.CommerceApi
+      run: | 
+        dotnet nuget add source https://nuget.pkg.github.com/andrewmarkham/index.json --name "GithubBuild" --store-password-in-clear-text --username andrewmarkham --password ${{ secrets.PACKAGE_TOKEN }}
+        dotnet nuget add source https://api.nuget.optimizely.com/v3/index.json --name "Optimizely"
+
+    - name: Restore (nuget.exe)
+      run: dotnet restore Jhoose.CommerceApi.csproj --configfile ../../Nuget.config
+      working-directory: ./src/Jhoose.CommerceApi
+
+    - name: Build (Production)
+      if: github.ref == 'refs/heads/main'
+      run: dotnet build --configuration Release --no-restore -p:Version=${{ env.BUILD_NO }}
+      working-directory: ./src/Jhoose.CommerceApi
+
+    - name: Build (Pre Release)
+      if: github.ref != 'refs/heads/main'
+      run: dotnet build --configuration PreRelease --no-restore -p:Version=${{ env.BUILD_NO_PRE }}
+      working-directory: ./src/Jhoose.CommerceApi
+
+    - name: Run Jhoose.CommerceApi.Tests
+      working-directory: ./src/Jhoose.CommerceApi.Tests
+      run: dotnet test Jhoose.CommerceApi.Tests.csproj   --no-restore  --configuration Release --logger "trx;LogFileName=test_results.trx"
+
+    - name: nuget push
+      if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/heads/release')
+      working-directory: ./src/Jhoose.CommerceApi
+      run: dotnet nuget push "**/Jhoose.CommerceApi*.nupkg" -k ${{ secrets.PACKAGE_TOKEN }} -s https://nuget.pkg.github.com/andrewmarkham/index.json --skip-duplicate
+      env:
+        GITHUB_TOKEN: ${{ secrets.PACKAGE_TOKEN }}

.vscode/tasks.json

@@ -20,7 +20,7 @@
             "args": [
                 "watch",
                 "run",
-                "${workspaceFolder}/src/Sample/DemoSite/DemoSite.csproj",
+                "${workspaceFolder}/src/Jhoose.Demo/Jhoose.Demo.csproj",
                 "/property:GenerateFullPaths=true",
                 "/consoleloggerparameters:NoSummary"
             ],

Developer Notes.md

@@ -81,7 +81,7 @@ COMMERCE_AUTHORIZATION_KEY = ...
  - npm run build - builds and packages the project.
  - npm run test - runs the unit tests
  - npm run testf - runs the unit functional tests, requires the Rest API to be running
-  - npm run doc - creates the documentation
+ - npm run doc - creates the documentation
 
  ### components
   This is the reactjs component library

README.md

@@ -12,11 +12,15 @@ A Rest API layer that supports these common eCommerce journies
 - Pricing
 - Markets
 
+See [Customer Rest API](./docs/customerRestapi.md)
+
 #### Javascript/Typescript Customer API Layer
-This library provides an abstration of the Rest API which simplifies the approach when developing either clientside components in Vanilla JS or more complex applications via Frameworks such as NEXT.js or Angular.
+This library provides an abstration of the Rest API which simplifies the approach when developing either client-side components in Vanilla JS or more complex applications via Frameworks such as NEXT.js, React or Angular.
 - Parity functionality to the Customer Rest API
 - Caching to enhance performance
 
+See [Javascript Customer API Layer](https://github.com/andrewmarkham/CommerceApi.Frontend/blob/main/docs/javascriptapi.md)
+
 #### Microfront UI Layer
 This is a React framework that delivers a core set of components that can be used to accelerate development.
 
@@ -28,6 +32,8 @@ This is a React framework that delivers a core set of components that can be use
 
 The components can be styled to match designs.
 
+See [Micro UI Layer](https://github.com/andrewmarkham/CommerceApi.Frontend/blob/main/docs/microfrontend.md)
+
 ---
 ## Why
 
@@ -53,17 +59,31 @@ The Rest API can be used by Websites, POS, Mobile apps, surfacing the same Cart,
 ### Authentication
 See [Authentication](./docs/authentication.md)
 
+### Markets
+See [Markets](./docs/markets.md)
+
+### Extensibility
+Feature [Extensibility](https://github.com/andrewmarkham/CommerceApi/issues/2)
+
+---
+## Getting Started
+Please read the [Customer Rest API](./docs/customerRestapi.md) documentation to understand how to add the framework to an existing Optimizely Commerce solution.
+
+For an example api site please see [Jhoose Demo](./src/Jhoose.Demo/README.md)
+
+For an example headless site (Next.js) please see [Ozone Clothing](https://github.com/andrewmarkham/OzoneClothing)
+
 ---
 ## API Documentation
 
 ### Customer Rest API Layer
 See [Customer Rest API](./docs/customerRestapi.md)
 
 ### Javascript Customer API Layer
-See [Javascript Customer API Layer](./docs/javascriptapi.md)
+See [Javascript Customer API Layer](https://github.com/andrewmarkham/CommerceApi.Frontend/blob/main/docs/javascriptapi.md)
 
 ### Micro UI Layer
-See [Micro UI Layer](./docs/microfrontend.md)
+See [Micro UI Layer](https://github.com/andrewmarkham/CommerceApi.Frontend/blob/main/docs/microfrontend.md)
 
 ---