Novu•3mo ago

Better Readme on Novu Init

Guys maybe this info thats here could fit in a good shape at the readme file. As i passed like 20 minutes trying to identify how to start the dev mode and bridging all there. My readme looked like this:

# Novu Bridge App

This is a [Novu](https://novu.co/) bridge application bootstrapped with [`npx novu init`](https://www.npmjs.com/package/novu)

## Getting Started

To run the development server, run:

bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

By default, the [Next.js](https://nextjs.org/) server will start and your state can be synchronized with Novu Cloud via the Bridge Endpoint (default is `/api/novu`). Your server will by default run on [http://localhost:4000](http://localhost:4000).

## Your first workflow 

Your first email workflow can be edited in `./app/novu/workflows.ts`. You can adjust your workflow to your liking.

## Learn More     

To learn more about Novu, take a look at the following resources:

- [Novu](https://novu.co/)

You can check out [Novu GitHub repository](https://github.com/novuhq/novu) - your feedback and contributions are welcome!

# Novu Bridge App

This is a [Novu](https://novu.co/) bridge application bootstrapped with [`npx novu init`](https://www.npmjs.com/package/novu)

## Getting Started

To run the development server, run:

bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

By default, the [Next.js](https://nextjs.org/) server will start and your state can be synchronized with Novu Cloud via the Bridge Endpoint (default is `/api/novu`). Your server will by default run on [http://localhost:4000](http://localhost:4000).

## Your first workflow 

Your first email workflow can be edited in `./app/novu/workflows.ts`. You can adjust your workflow to your liking.

## Learn More     

To learn more about Novu, take a look at the following resources:

- [Novu](https://novu.co/)

You can check out [Novu GitHub repository](https://github.com/novuhq/novu) - your feedback and contributions are welcome!

2 Replies

Dima Grossman•3mo ago

@iStun4Fun just to make sure I understood you, do you mean updating the readme with the content from the UI?

iStun4FunOP•3mo ago

Hey Dima yes, im having a hard time setuping this, tried to setup at our main app, and it gives a lot of errors... so i have to create a different service to run novu and will be harder to maintain in different repos ill add a ticket for that

Gaming

Programming

Better Readme on Novu Init

Did you find this page helpful?