chore(create-novu-app): Update README with quickstart guide and relea…

…se (#5709) * docs(create-novu-app): update README with quickstart guide * style: Remove unnecessary eslint-disable comments * chore: Add ESLint config for create-novu-app * style: Remove eslint-disable comments * chore: bump version to 0.24.3-alpha.4
novuhq · Jun 13, 2024 · c5382f5 · c5382f5
1 parent 5d7a964
commit c5382f5
Show file tree

Hide file tree

Showing 10 changed files with 41 additions and 15 deletions.
diff --git a/packages/create-novu-app/.eslintrc.js b/packages/create-novu-app/.eslintrc.js
@@ -0,0 +1,6 @@
+module.exports = {
+  extends: ['../../.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/naming-convention': 'off',
+  },
+};
diff --git a/packages/create-novu-app/README.md b/packages/create-novu-app/README.md
@@ -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.
diff --git a/packages/create-novu-app/package.json b/packages/create-novu-app/package.json
@@ -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",

diff --git a/packages/create-novu-app/templates/app-react-email/ts/app/echo/emails/vercel.tsx b/packages/create-novu-app/templates/app-react-email/ts/app/echo/emails/vercel.tsx
@@ -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,

diff --git a/packages/create-novu-app/templates/app-react-email/ts/app/layout.tsx b/packages/create-novu-app/templates/app-react-email/ts/app/layout.tsx
@@ -1,4 +1,3 @@
-/* eslint-disable */
 import type { Metadata } from "next";
 import { Inter } from "next/font/google";
 import "./globals.css";

diff --git a/packages/create-novu-app/templates/app-react-email/ts/app/page.tsx b/packages/create-novu-app/templates/app-react-email/ts/app/page.tsx
@@ -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">

diff --git a/packages/create-novu-app/templates/app/ts/app/layout.tsx b/packages/create-novu-app/templates/app/ts/app/layout.tsx
@@ -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<{

diff --git a/packages/create-novu-app/templates/app/ts/app/page.tsx b/packages/create-novu-app/templates/app/ts/app/page.tsx
@@ -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}>

diff --git a/packages/create-novu-app/templates/index.ts b/packages/create-novu-app/templates/index.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 import { install } from "../helpers/install";
 import { copy } from "../helpers/copy";
 
@@ -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";
         }
@@ -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 });

diff --git a/packages/create-novu-app/templates/types.ts b/packages/create-novu-app/templates/types.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 import { PackageManager } from "../helpers/get-pkg-manager";
 
 export type TemplateType =