Merge pull request #88 from novuhq/todd/versioning-differences

Release 0.4.0 for full compatability to Novu 0.24.0

Author: toddb

.github/workflows/dotnet-deploy.yaml

@@ -20,7 +20,7 @@ jobs:
       - name: Setup .NET
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 7.0.x
+          dotnet-version: 8.0.x
 
       # Step Two: build
       - name: Build Novu Solution (all projects)

.github/workflows/dotnet-test.yaml

@@ -14,7 +14,7 @@ jobs:
       - name: Setup .NET
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 7.0.x
+          dotnet-version: 8.0.x
 
       ## Restore Novu as a solution
       - name: Restore dependencies

.gitignore

@@ -7,4 +7,6 @@ obj
 .DS_STORE
 src/Novu.sln.DotSettings.user
 **/.vs
-appsettings.todd.json
+appsettings.todd.json
+**/.env
+**/refitter/**

CONTRIBUTING.md

@@ -19,12 +19,16 @@ You can open a new issue with this [issue form](https://github.com/novuhq/novu-d
 
 ### Requirements
 
-- .NET 7
+- .NET 8
 - Novu API Key - Can be located at https://web.novu.co/settings
 
 ### Setup the project
 
-Clone the repository and run `dotnet restore` against `Novu.sln` 
+* Clone the repository and run `dotnet restore` against `Novu.sln`
+* docker files for local development in docker folder
+* difference between versions in specs folder
+* autogen contract files for versions in refitter folder
+* Start the local docker version of Novu against the version you are reporting/building against
 
 ## Missing a Feature?
 

README.md

@@ -0,0 +1,55 @@
+#
+# copy this file to .env to be picked up by docker-compose
+#
+# see https://github.com/novuhq/novu/pkgs/container/novu%2Fapi to find version
+IMAGE_VERSION=0.24.4
+
+# Secrets
+# YOU MUST CHANGE THESE BEFORE GOING INTO PRODUCTION
+JWT_SECRET=<Must be 128 bits (16 chars)>>
+STORE_ENCRYPTION_KEY=<ENCRYPTION_KEY_MUST_BE_32_LONG>
+
+# General
+NODE_ENV=local
+
+MONGO_PORT=27017
+MONGO_MAX_POOL_SIZE=500
+
+FORWARD_MINIO_CONSOLE_PORT=9090
+FORWARD_MINIO_PORT=9000
+
+REDIS_PORT=6379
+REDIS_CACHE_SERVICE_PORT=6379
+REDIS_HOST=redis
+REDIS_CACHE_SERVICE_HOST=
+REDIS_PASSWORD=
+
+# AWS
+AWS_REGION=us-east-1
+AWS_ACCESS_KEY_ID=<4_CHARS>
+AWS_SECRET_ACCESS_KEY=<7_CHARS>
+
+S3_BUCKET_NAME=local-notifications
+S3_REGION=us-east-1
+
+# Novu Ports
+API_PORT=3000
+WS_PORT=3002
+APP_PORT=4200
+WIDGET_PORT=4500
+WIDGET_EMBED_PORT=4701
+
+DISABLE_USER_REGISTRATION=false
+
+# Context Paths
+# Only needed for setups with reverse-proxies
+GLOBAL_CONTEXT_PATH=
+WEB_CONTEXT_PATH=
+API_CONTEXT_PATH=
+WS_CONTEXT_PATH=
+WIDGET_CONTEXT_PATH=
+
+# Analytics
+SENTRY_DSN=
+NEW_RELIC_APP_NAME=
+NEW_RELIC_LICENSE_KEY=

docker/.env.example

@@ -0,0 +1,49 @@
+Docker is used to self-host Novu for testing.
+
+### Before you begin
+
+You need the following installed in your system:
+
+- [Docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/)
+
+### Start Novu
+
+```sh
+# Start Novu
+docker-compose -f ./docker/docker-compose.yml up
+```
+
+### Change settings
+
+The current docker compose file has default settings to work immediately in testing. However, any
+can be changed by creating your own `.env` file:
+
+```sh
+# Go to the docker folder
+cd docker
+
+# Copy the example env file (and make changes, but should work on defaults)
+# the version of the Novu docker images are set in the .env file
+cp .env.example .env
+
+# Start Novu
+docker-compose -f ./docker-compose.yml up
+```
+
+### Testing
+
+* The `appsettings.Integration.json` file is pointing at http:localhost:3000
+* [http://127.0.0.1:4200](http://127.0.0.1:4200) for the API key on the organisation
+
+```json
+{
+  "Novu": {
+    "Url": "http://localhost:3000/v1",
+    "ApiKey": "082f1cdac19663855359343735aae5b1"
+  }
+}
+```
+
+### OpenApi
+
+* [http://127.0.0.1:3000/openapi](http://127.0.0.1:3000/openapi)[.json|yaml]