{"id":20508592,"url":"https://github.com/novuhq/connect","last_synced_at":"2025-04-13T22:08:45.600Z","repository":{"id":156648874,"uuid":"629466640","full_name":"novuhq/connect","owner":"novuhq","description":null,"archived":false,"fork":false,"pushed_at":"2024-02-29T20:14:35.000Z","size":2550,"stargazers_count":10,"open_issues_count":2,"forks_count":1,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-04-13T22:08:39.254Z","etag":null,"topics":["hackathon","novu"],"latest_commit_sha":null,"homepage":"https://connect.novu.co/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/novuhq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-04-18T11:24:59.000Z","updated_at":"2024-11-01T14:02:43.000Z","dependencies_parsed_at":"2023-11-09T16:29:37.505Z","dependency_job_id":"e17ba28f-3192-48ec-85d6-6668ef5c9785","html_url":"https://github.com/novuhq/connect","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novuhq%2Fconnect","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novuhq%2Fconnect/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novuhq%2Fconnect/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novuhq%2Fconnect/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/novuhq","download_url":"https://codeload.github.com/novuhq/connect/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248788938,"owners_count":21161727,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hackathon","novu"],"created_at":"2024-11-15T20:19:22.576Z","updated_at":"2025-04-13T22:08:45.555Z","avatar_url":"https://github.com/novuhq.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ConnectNovu\n\nThis is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).\n\n## Table of Contents\n\n- [Getting Started](#getting-started)\n- [Usage](#usage)\n  - [Learn more](#learn-more)\n  - [Build the website](#deploy-on-vercel)\n- [Project Structure](#project-structure)\n- [Code Style](#code-style)\n  - [ESLint](#eslint)\n  - [Prettier](#prettier)\n  - [VS Code](#vs-code)\n\n## Getting Started\n\n1. Clone this repository or hit \"Use this template\" button\n\n```bash\ngit clone git@github.com:pixel-point/nextjs-tailwind-starter.git\n```\n\n2. Install dependencies\n\n```bash\nnpm install\n```\n\n## Usage\n\n```bash\nnpm run dev\n```\n\nOpen [http://localhost:3000](http://localhost:3000) with your browser to see the result.\n\nYou can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.\n\n### Learn More\n\nTo learn more about Next.js, take a look at the following resources:\n\n- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.\n- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.\n\nYou can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!\n\n### Deploy on Vercel\n\nThe easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/import?utm_medium=default-template\u0026filter=next.js\u0026utm_source=create-next-app\u0026utm_campaign=create-next-app-readme) from the creators of Next.js.\n\nCheck out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.\n\n## Project Structure\n\n```text\n├── public\n├── src\n│   ├── components\n│   │  ├── pages — React components that are being used specifically on a certain page\n│   │  └── shared — React components that are being used across the whole website\n│   ├── hooks\n│   ├── images\n│   ├── pages\n│   ├── styles\n│   ├── utils\n├── next.config.js — Main configuration file for a Next.js site. Read more about it [here](https://nextjs.org/docs/api-reference/next.config.js/introduction)\n├── postcss.config.js — Main configuration file of PostCSS. [Read more about it here](https://tailwindcss.com/docs/configuration#generating-a-post-css-configuration-file)\n└── tailwind.config.js — Main configuration file for Tailwind CSS [Read more about it here](https://tailwindcss.com/docs/configuration)\n```\n\n## Component Folder Structure\n\n### Each component includes\n\n1. Main JavaScript File\n2. Index File\n\n### Each component optionally may include\n\n1. Folder with images and icons\n2. Folder with data\n\nAlso, each component may include another component that follows all above listed rules.\n\n### Example structure\n\n```bash\ncomponent\n├── nested-component\n│  ├── data\n│  │  └── nested-component-lottie-data.json\n│  ├── images\n│  │  ├── nested-component-image.jpg\n│  │  ├── nested-component-inline-svg.inline.svg\n│  │  └── nested-component-url-svg.url.svg\n│  ├── nested-component.js\n│  └── index.js\n├── data\n│  └── component-lottie-data.json\n├── images\n│  ├── component-image.jpg\n│  ├── component-inline-svg.inline.svg\n│  └── component-url-svg.url.svg\n├── component.js\n└── index.js\n```\n\n## Code Style\n\n### ESLint\n\n[ESLint](https://eslint.org/) helps find and fix code style issues and force developers to follow same rules. Current configuration is based on [Airbnb style guide](https://github.com/airbnb/javascript).\n\nAdditional commands:\n\n```bash\nnpm run lint\n```\n\nRun it to check the current status of eslint issues across project.\n\n```bash\nnpm run lint:fix\n```\n\nRun it to fix all possible issues.\n\n### Prettier\n\n[Prettier](https://prettier.io/) helps to format code based on defined rules. [Difference between Prettier and ESLint](https://prettier.io/docs/en/comparison.html).\n\nAdditional commands:\n\n```bash\nnpm run format\n```\n\nRun it to format all files across the project.\n\n### VS Code\n\nFollowing extensions required to simplify the process of keeping the same code style across the project:\n\n- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)\n- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)\n\nAfter installation enable \"ESLint on save\" by adding to your VS Code settings.json the following line:\n\n```json\n\"editor.codeActionsOnSave\": {\n    \"source.fixAll.eslint\": true\n}\n```\n\nYou can navigate to settings.json by using Command Pallete (CMD+Shift+P) and then type \"Open settings.json\".\n\nTo enable Prettier go to Preferences -\u003e Settings -\u003e type \"Format\". Then check that you have esbenp.prettier-vscode as default formatter, and also enable \"Format On Save\".\n\nReload VS Code and auto-format will work for you.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnovuhq%2Fconnect","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnovuhq%2Fconnect","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnovuhq%2Fconnect/lists"}