Read more about how to add a [notification center Inbox](https://docs.novu.co/inbox/react/get-started?utm_campaign=github-readme) to your app.
+
## Providers
@@ -217,6 +219,7 @@ We are more than happy to help you. If you are getting any errors or facing prob
Novu is a commercial open source company, which means some parts of this open source repository require a commercial license. The concept is called "Open Core," where the core technology is fully open source, licensed under MIT license, and the enterprise code is covered under a commercial license ("/enterprise" Enterprise Edition). Enterprise features are built by the core engineering team of Novu which is hired in full-time.
The following modules and folders are licensed under the enterprise license:
+
- `enterprise` folder at the root of the project and all of their subfolders and modules
- `apps/web/src/ee` folder and all of their subfolders and modules
- `apps/dashboard/src/ee` folder and all of their subfolders and modules
diff --git a/SECURITY.md b/SECURITY.md
index 9b94c6ade88..4f7605572fb 100644
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -46,7 +46,7 @@ If you come across a vulnerability, please inform us promptly so we can promptly
6. Please share enough details for us to understand and fix the issue as fast as we can. Typically, providing the IP address or the URL of the affected system along with a description of the problem should be enough, though more intricate issues might need additional clarification.
-## What *We* Promise
+## What _We_ Promise
1. We'll get back to you within 3 business days with our assessment of the report and an estimated date when we expect to resolve it.
diff --git a/apps/api/.spectral.yaml b/apps/api/.spectral.yaml
index 31d5ceb4c92..482288d25ed 100644
--- a/apps/api/.spectral.yaml
+++ b/apps/api/.spectral.yaml
@@ -14,9 +14,9 @@ extends: [[spectral:oas, all]]
# https://meta.stoplight.io/docs/spectral/293426e270fac-overrides
overrides:
- files:
- - "**#/paths/~1v1~1subscribers~1%7BsubscriberId%7D~1preferences~1%7BtemplateId%7D"
- - "**#/paths/~1v1~1subscribers~1%7BsubscriberId%7D~1preferences~1%7Blevel%7D"
- - "**#/paths/~1v1~1workflows~1%7BworkflowIdOrIdentifier%7D"
- - "**#/paths/~1v1~1notification-templates~1%7BworkflowIdOrIdentifier%7D"
+ - '**#/paths/~1v1~1subscribers~1%7BsubscriberId%7D~1preferences~1%7BtemplateId%7D'
+ - '**#/paths/~1v1~1subscribers~1%7BsubscriberId%7D~1preferences~1%7Blevel%7D'
+ - '**#/paths/~1v1~1workflows~1%7BworkflowIdOrIdentifier%7D'
+ - '**#/paths/~1v1~1notification-templates~1%7BworkflowIdOrIdentifier%7D'
rules:
- path-params: "off"
+ path-params: 'off'
diff --git a/apps/api/README.md b/apps/api/README.md
index 477c6f02fd3..bee04293f68 100644
--- a/apps/api/README.md
+++ b/apps/api/README.md
@@ -11,7 +11,6 @@
A RESTful API for accessing the Novu platform, built using [NestJS](https://nestjs.com/).
-
## Running the API
See the docs for [Run in Local Machine](https://docs.novu.co/community/run-in-local-machine?utm_campaign=github-api-readme) to get setup. Then run:
@@ -24,30 +23,37 @@ $ npm run start:api
## Test
### Unit Tests
+
```bash
# unit tests
$ npm run test
```
### E2E tests
+
See the docs for [Running on Local Machine - API Tests](https://docs.novu.co/community/run-in-local-machine#api?utm_campaign=github-api-readme).
## Adding a new Endpoint
+
### Choose the right controller / new controller.
+
- If the endpoint is related to an existing entity, add the endpoint to the existing controller.
+
### Add the correct decorators to the controller method.
+
- Use the `@Get`, `@Post`, `@Put`, `@Delete` decorators to define the HTTP method.
- Use the `@Param`, `@Query`, `@Body` decorators to define the parameters.
- Use the `@UserAuthentication()` decorator to define the guards as well as make it accessible to novu web app.
- Use the @ExternalApiAccessible decorator to define the endpoint as accessible by external API (Users with Api-Key) & The official Novu SDK.
-#### Naming conventions
- - for the controller methods should be in the format `getEntityName`, `createEntityName`, `updateEntityName`, `deleteEntityName`.
- - In Case of a getAll / List use the `list` prefix for the method name and don't forget to add pagination functionality.
- - Use the `@SdkUsePagination` decorator to alert the sdk of a paginated endpoint (will improve DX with an async iterator) the pagination parameters.
- - In case of a uniuqe usecase outside of the basic REST operations, attempt to use the regular naming conventions just for a sub-resource.
- - `@SdkGroupName` - Use this decorator to group the endpoints in the SDK, use `.` separator to create a subresource (Ex' 'Subscribers.Notifications' getSubscriberNotifications), the original resource is defined as an openApi Tag .
- - `@SdkMethodName` in case of a unique operation, use this decorator to define the method name in the SDK.
+#### Naming conventions
+
+- for the controller methods should be in the format `getEntityName`, `createEntityName`, `updateEntityName`, `deleteEntityName`.
+- In Case of a getAll / List use the `list` prefix for the method name and don't forget to add pagination functionality.
+ - Use the `@SdkUsePagination` decorator to alert the sdk of a paginated endpoint (will improve DX with an async iterator) the pagination parameters.
+- In case of a uniuqe usecase outside of the basic REST operations, attempt to use the regular naming conventions just for a sub-resource.
+ - `@SdkGroupName` - Use this decorator to group the endpoints in the SDK, use `.` separator to create a subresource (Ex' 'Subscribers.Notifications' getSubscriberNotifications), the original resource is defined as an openApi Tag .
+ - `@SdkMethodName` in case of a unique operation, use this decorator to define the method name in the SDK.
## OpenAPI (formerly Swagger)
@@ -63,8 +69,8 @@ $ npm run lint:openapi
The command will return warnings and errors that must be fixed before the Github action will pass. These fixes are created by making changes through the `@nestjs/swagger` decorators.
-
## Migrations
+
Database migrations are included for features that have a hard dependency on specific data being available on database entities. These migrations are run by both Novu Cloud and Novu Self-Hosted users to support new feature releases.
### How to Run
diff --git a/apps/api/jarvis-api-intro.md b/apps/api/jarvis-api-intro.md
index f5ef84776ef..5ec0272cb3b 100644
--- a/apps/api/jarvis-api-intro.md
+++ b/apps/api/jarvis-api-intro.md
@@ -1,6 +1,6 @@
Hi, I'm Jarvis đ¤
-I'm a bot built to help you with your contribution to Novu.
+I'm a bot built to help you with your contribution to Novu.
I will add instructions and guides on how to run the subset of the Novu platform associated to this issue and make your first contribution.
This issue was tagged as related to `@novu/api` and the related code is located at the `apps/api` folder, here is how I can help you:
@@ -8,19 +8,23 @@ This issue was tagged as related to `@novu/api` and the related code is located
First time contributing to Novu?
- If that's the first time you want to contribute to Novu here are a few simple steps to get you started: - 1. Fork the repository and clone your fork to your local machine. - 2. Install the dependencies using `npm run setup:project`. - 3. Create a new branch with the number of the issue, for example: `1454-fix-something-cool` and start contributing based on the [Contributing Guide](https://docs.novu.co/community/run-in-local-machine?utm_campaign=github-jarvis) or the short guide in the section below. - 4. Create a Pull request and follow the template of creation +If that's the first time you want to contribute to Novu here are a few simple steps to get you started: + +1. Fork the repository and clone your fork to your local machine. +2. Install the dependencies using `npm run setup:project`. +3. Create a new branch with the number of the issue, for example: `1454-fix-something-cool` and start contributing based on the [Contributing Guide](https://docs.novu.co/community/run-in-local-machine?utm_campaign=github-jarvis) or the short guide in the section below. +4. Create a Pull request and follow the template of creationRun and test `@novu/api` locally
- ### Run API in watch mode - The easiest way to start the API is to run `npm run start:api` from the root of the repository +### Run API in watch mode + +The easiest way to start the API is to run `npm run start:api` from the root of the repository + +### Run API integration tests + +To validate your changes or simply to run the e2e tests run `npm run start:e2e:api`. All the e2e tests have the `.e2e.ts` suffix and usually are located near the controller files of each module. - ### Run API integration tests - To validate your changes or simply to run the e2e tests run `npm run start:e2e:api`. All the e2e tests have the `.e2e.ts` suffix and usually are located near the controller files of each module.Configure
-
+
Presets for popular tools
Easy setup for TypeScript, SCSS and more.
-
+
Build configuration
How to customize webpack and Babel
-
+
Styling
@@ -208,6 +196,5 @@ We recommend building UIs with a [**component-driven**](https://componentdriven.
- TipEdit the Markdown in{' '}
-
diff --git a/apps/web/src/studio/components/GetStartedPageV2/index.tsx b/apps/web/src/studio/components/GetStartedPageV2/index.tsx
index 714267accb0..e55d5d99c45 100644
--- a/apps/web/src/studio/components/GetStartedPageV2/index.tsx
+++ b/apps/web/src/studio/components/GetStartedPageV2/index.tsx
@@ -174,7 +174,7 @@ export const GetStartedPageV2 = ({ location }: { location: 'onboarding' | 'get-s
border: 'none !important',
padding: '1px',
borderRadius: '100',
- boxShadow: 'dark !important',
+ boxShadow: '!important dark',
})}
onDoubleClick={() => {
track('Command copied - [Get Started - V2]');
diff --git a/apps/widget/README.md b/apps/widget/README.md
index 9516c111986..c60613a517f 100644
--- a/apps/widget/README.md
+++ b/apps/widget/README.md
@@ -1,9 +1,9 @@
# Widget
-
## How to run e2e test in local?
Run `npm run start:test` script in the following apps on separate terminals:
+
1. apps/api
2. apps/ws
3. apps/widget
diff --git a/apps/widget/config-overrides.js b/apps/widget/config-overrides.js
index 404a228034a..1db88e6c840 100644
--- a/apps/widget/config-overrides.js
+++ b/apps/widget/config-overrides.js
@@ -2,8 +2,8 @@ const { useBabelRc, override } = require('customize-cra');
// const BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlugin;
function overrideConfig(config, env) {
- const plugins = [...config.plugins, /* new BundleAnalyzerPlugin() */];
-
+ const plugins = [...config.plugins /* new BundleAnalyzerPlugin() */];
+
return { ...config, plugins };
}
diff --git a/apps/widget/cypress/test-shell/example/test.html b/apps/widget/cypress/test-shell/example/test.html
index 8b92cf1b1dc..c49c361a16d 100644
--- a/apps/widget/cypress/test-shell/example/test.html
+++ b/apps/widget/cypress/test-shell/example/test.html
@@ -1,10 +1,10 @@
-
-
-
-
- src/stories/Introduction.stories.mdx
+ TipEdit the Markdown in src/stories/Introduction.stories.mdx
-