-
Notifications
You must be signed in to change notification settings - Fork 3.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore(create-novu-app): Update README with quickstart guide and release #5709
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
4c40515
docs(create-novu-app): update README with quickstart guide
rifont 468b399
style: Remove unnecessary eslint-disable comments
rifont d74cbed
chore: Add ESLint config for create-novu-app
rifont ab2fcc8
style: Remove eslint-disable comments
rifont bc5e01a
chore: bump version to 0.24.3-alpha.4
rifont File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,6 @@ | ||
module.exports = { | ||
extends: ['../../.eslintrc.js'], | ||
rules: { | ||
'@typescript-eslint/naming-convention': 'off', | ||
}, | ||
}; |
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 |
---|---|---|
@@ -1,7 +1,27 @@ | ||
<div align="center"> | ||
<a href="https://novu.co?utm_source=github" target="_blank"> | ||
<picture> | ||
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/2233092/213641039-220ac15f-f367-4d13-9eaf-56e79433b8c1.png"> | ||
<img alt="Novu Logo" src="https://user-images.githubusercontent.com/2233092/213641043-3bbb3f21-3c53-4e67-afe5-755aeb222159.png" width="280"/> | ||
</picture> | ||
</a> | ||
</div> | ||
|
||
# Create Novu App | ||
|
||
[![Version](https://img.shields.io/npm/v/create-novu-app.svg)](https://www.npmjs.org/package/create-novu-app) | ||
[![Downloads](https://img.shields.io/npm/dm/create-novu-app.svg)](https://www.npmjs.com/package/create-novu-app) | ||
|
||
The easiest way to get started with Novu workflows is to call `create-novu-app`. The command will ask you for a project name as well as if you want to use react email. | ||
|
||
### Why use Create Novu App? | ||
## Quickstart | ||
|
||
You can get started by retrieving your Novu API key from the [settings page](https://web.novu.co/settings), then run: | ||
|
||
```bash | ||
npx create-novu-app@latest --api-key=<NOVU_API_KEY> | ||
``` | ||
|
||
## Why use Create Novu App? | ||
|
||
`create-novu-app` allows you to create a new Novu app within seconds. |
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 |
---|---|---|
@@ -1,13 +1,16 @@ | ||
{ | ||
"name": "create-novu-app", | ||
"version": "0.24.2", | ||
"version": "0.24.3-alpha.4", | ||
"keywords": [ | ||
"novu" | ||
"novu", | ||
"create", | ||
"notifications", | ||
"next.js" | ||
], | ||
"description": "Create Novu-powered apps with one command", | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/novuhq/novu" | ||
"url": "git+https://github.com/novuhq/novu.git" | ||
}, | ||
"author": "Novu Team <[email protected]>", | ||
"license": "MIT", | ||
|
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
1 change: 0 additions & 1 deletion
1
packages/create-novu-app/templates/app-react-email/ts/app/layout.tsx
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
1 change: 0 additions & 1 deletion
1
packages/create-novu-app/templates/app-react-email/ts/app/page.tsx
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
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 |
---|---|---|
@@ -1,4 +1,3 @@ | ||
/* eslint-disable */ | ||
import { PackageManager } from "../helpers/get-pkg-manager"; | ||
|
||
export type TemplateType = | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💭 thought (non-blocking): The url will navigate the users to the US version of the site, but the EU users might get confused, don't know if we care a this point.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
EU takes about 1% of the traffic that US has today, EU users will know to add the
eu.
prefix. We don't care right now.