Skip to content
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 5 commits into from
Jun 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/create-novu-app/.eslintrc.js
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',
},
};
22 changes: 21 additions & 1 deletion packages/create-novu-app/README.md
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:
Copy link
Contributor

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.

Copy link
Collaborator Author

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.


```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.
9 changes: 6 additions & 3 deletions packages/create-novu-app/package.json
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",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ const baseUrl = process.env.VERCEL_URL
? `https://react-email-demo-bdj5iju9r-resend.vercel.app`
: "https://react-email-demo-bdj5iju9r-resend.vercel.app";

// eslint-disable-next-line @typescript-eslint/naming-convention
export const VercelInviteUserEmail = ({
username,
showButton,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
import type { Metadata } from "next";
import { Inter } from "next/font/google";
import "./globals.css";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import Image from "next/image";

// eslint-disable-next-line @typescript-eslint/naming-convention
export default function Home() {
return (
<main className="flex min-h-screen flex-col items-center justify-between p-24">
Expand Down
1 change: 0 additions & 1 deletion packages/create-novu-app/templates/app/ts/app/layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ export const metadata: Metadata = {
description: "Generated by create next app",
};

// eslint-disable-next-line @typescript-eslint/naming-convention
export default function RootLayout({
children,
}: Readonly<{
Expand Down
1 change: 0 additions & 1 deletion packages/create-novu-app/templates/app/ts/app/page.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import Image from "next/image";
import styles from "./page.module.css";

// eslint-disable-next-line @typescript-eslint/naming-convention
export default function Home() {
return (
<main className={styles.main}>
Expand Down
13 changes: 8 additions & 5 deletions packages/create-novu-app/templates/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
import { install } from "../helpers/install";
import { copy } from "../helpers/copy";

Expand Down Expand Up @@ -66,8 +65,10 @@ export const installTemplate = async ({
case "eslintrc.json": {
return `.${name}`;
}
// README.md is ignored by webpack-asset-relocator-loader used by ncc:
// https://github.com/vercel/webpack-asset-relocator-loader/blob/e9308683d47ff507253e37c9bcbb99474603192b/src/asset-relocator.js#L227
/*
* README.md is ignored by webpack-asset-relocator-loader used by ncc:
* https://github.com/vercel/webpack-asset-relocator-loader/blob/e9308683d47ff507253e37c9bcbb99474603192b/src/asset-relocator.js#L227
*/
case "README-template.md": {
return "README.md";
}
Expand Down Expand Up @@ -100,8 +101,10 @@ export const installTemplate = async ({
cwd: root,
dot: true,
stats: false,
// We don't want to modify compiler options in [ts/js]config.json
// and none of the files in the .git folder
/*
* We don't want to modify compiler options in [ts/js]config.json
* and none of the files in the .git folder
*/
ignore: ["tsconfig.json", "jsconfig.json", ".git/**/*"],
});
const writeSema = new Sema(8, { capacity: files.length });
Expand Down
1 change: 0 additions & 1 deletion packages/create-novu-app/templates/types.ts
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 =
Expand Down
Loading