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

Changed the structure of the examples repo #50

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
50 changes: 50 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
Here’s a suggested main README page for your examples repository, built around the template you provided. This structure emphasizes clarity, accessibility, and ease of navigation:

---

```markdown
<div align="center">
<a href="https://novu.co?utm_source=github" target="_blank">

Expand Down Expand Up @@ -44,3 +49,48 @@ The ultimate service for managing multi-channel notifications with a single API.
·
<a href="https://notifications.directory">Notifications Directory</a>
</p>

---

## About this Repository

Welcome to the **Novu Examples Repository**! This repository serves as a comprehensive hub of examples, demos, and real-world applications to help you integrate, explore, and learn how to use the Novu notification infrastructure effectively.

### What You Will Find

- **Blog Post Examples**: These examples align with our blog posts, demonstrating how specific features of Novu are implemented and used.
- **Full Demo Applications**: Full-fledged demo applications that showcase the advanced and practical use of Novu's infrastructure across various use cases and integrations.
- **Notification Workflow Collection**:
Fully functioning collection of notification workflows using the code-first @novu/framework.


Each example is well-documented, with easy-to-follow steps to guide you through installation and usage.

---

## Repository Structure

```bash
examples/
├── blog-post-examples/ # Examples from our blog posts
│ ├── example-1/
│ ├── example-2/
│ └── ...
├── demo-apps/ # Full demo applications
│ ├── react/
│ │ ├── app-1/
│ │ └── app-2/
│ ├── angular/
│ │ ├── app-1/
│ │ └── app-2/
│ └── ...
└── workflow-collection/ # Notification workflows library using @novu/framwork
```

---

## Stay Connected

Join our community on [Discord](https://discord.novu.co) and follow us on [X (formerly Twitter)](https://twitter.com/novuhq) to stay updated with the latest news, releases, and discussions around Novu.
Binary file removed react-dream-todo-app/BackEnd/.DS_Store
Binary file not shown.
File renamed without changes.
File renamed without changes.
Binary file removed vue-nextjs-trigger-inapp-notifications/.DS_Store
Binary file not shown.
7 changes: 0 additions & 7 deletions vue-nextjs-trigger-inapp-notifications/client/.env

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

26 changes: 0 additions & 26 deletions vue-nextjs-trigger-inapp-notifications/client/dist/index.html

This file was deleted.

Binary file not shown.
4 changes: 0 additions & 4 deletions vue-nextjs-trigger-inapp-notifications/server-next/.env

This file was deleted.

Binary file not shown.
File renamed without changes.
Loading