{"id":19757979,"url":"https://github.com/xyflow/web","last_synced_at":"2025-04-04T13:05:59.454Z","repository":{"id":204863128,"uuid":"654072579","full_name":"xyflow/web","owner":"xyflow","description":"📖 This monorepo contains the xyflow website and the documentation sites for React Flow and Svelte Flow.","archived":false,"fork":false,"pushed_at":"2025-04-02T10:57:10.000Z","size":84363,"stargazers_count":79,"open_issues_count":31,"forks_count":83,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-02T11:30:04.813Z","etag":null,"topics":["api","react-flow","svelte-flow"],"latest_commit_sha":null,"homepage":"https://xyflow.com","language":"TypeScript","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/xyflow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yaml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"xyflow","custom":"https://reactflow.dev/pro"}},"created_at":"2023-06-15T10:27:50.000Z","updated_at":"2025-04-02T10:57:13.000Z","dependencies_parsed_at":"2025-04-02T11:35:49.443Z","dependency_job_id":null,"html_url":"https://github.com/xyflow/web","commit_stats":{"total_commits":1259,"total_committers":57,"mean_commits":"22.087719298245613","dds":0.6441620333598094,"last_synced_commit":"0d2ca46376d505db8add29f83c3dddb7848af5fb"},"previous_names":["xyflow/web"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xyflow%2Fweb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xyflow%2Fweb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xyflow%2Fweb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xyflow%2Fweb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xyflow","download_url":"https://codeload.github.com/xyflow/web/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247182337,"owners_count":20897379,"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":["api","react-flow","svelte-flow"],"created_at":"2024-11-12T03:22:24.168Z","updated_at":"2025-04-04T13:05:59.417Z","avatar_url":"https://github.com/xyflow.png","language":"TypeScript","funding_links":["https://github.com/sponsors/xyflow","https://reactflow.dev/pro"],"categories":[],"sub_categories":[],"readme":"![xyflow](https://github.com/xyflow/web/assets/2857535/36a86114-e925-4669-a2dd-d0ae35cce76d)\n\n# xyflow/web\n\nThis monorepo contains our team website and the docs for our libraries.\n\n- [xyflow.com](https://xyflow.com) - our team website and blog\n- [reactflow.dev](https://reactflow.dev) - the website and documentation for the React Flow library\n- [svelteflow.dev](https://svelteflow.dev) - the website and documentation for the Svelte Flow library\n\n## What's inside?\n\nWe're using [Turborepo](https://turbo.build/repo) to manage this monorepo because\nthere's a lot going on.\n\n### apps/\n\nThe apps directory contains projects that run on the backend or applications we\nmight want to run during development:\n\n- `apps/example-apps` contains all of our examples and tutorials for ReactFlow and SvelteFlow.\n- `apps/ui-components` houses all of the components for [React Flow Components](https://reactflow.dev/components).\n\n### packages/\n\nThe packages in this monorepo are reusable self-contained bits that we want to\nshare across our apps and websites. Much of it is configuration for the different\ntools we use:\n\n- `packages/eslint-config-xyflow`\n- `packages/xy-tailwind-config`\n- `packages/xy-tsconfig`\n- `packages/xy-ui` is a React component library that contains any components that\n  we want to share across our websites. The package encompasses everything from\n  page layouts, UI building blocks, and complex widgets. We often use\n  [Shadcn](https://ui.shadcn.com) when looking to add new components, and we style\n  everything with [Tailwind](https://tailwindcss.com).\n\n### sites/\n\nEach directory in the sites folder is a separate website that we deploy. The name\nof the directory always corresponds to the domain name of the website:\n\n- `sites/reactflow.dev` is the documentation site for React Flow. It, and the\n  rest of sites, are built with [Nextra](https://nextra.site/) and\n  [Next.js](https://nextjs.org/).\n- `sites/svelteflow.dev` is the documentation for our newest library, Svelte Flow.\n- `sites/xyflow.com` is the new home page for our organization. It contains our\n  blog and some information on how we approach open source development.\n\n## Getting started\n\nTo run any of the websites locally, you'll first need to install the dependencies\nand packages. We recommend using [pnpm](https://pnpm.io/) to manage your dependencies.\n\n```sh\npnpm install\n```\n\nIf you take a peek in `package.json` you'll see we have a few different scripts\nto run our apps. If you just want to run everything at once, you can just do:\n\n```sh\npnpm run dev\n```\n\nTo run the two documentation sites you can use:\n\n```sh\npnpm run dev:docs\n```\n\nFor everything else, there is an individual script to run each app independently:\n\n- `pnpm run dev:reactflow.dev`\n- `pnpm run dev:svelteflow.dev`\n- `pnpm run dev:xyflow.com`\n- `pnpm run dev:style`\n\n### Displaying Showcase Projects\n\nWe have a database of projects that use our libraries stored in notion. Both the\nReact Flow and Svelte Flow sites are fetching this data at build time using `getStaticProps`. You need to have a `.env.local` file with a `NOTION_API_SECRET` to make this work locally. Otherwise, placeholder showcases are shown.\n\n### Update React Flow and Svelte Flow dependencies\n\nThere is a Github action that checks the latest React Flow and Svelte Flow versions\ndaily and creates a PR if there is a new version.\n\n---\n\n## Support our work with React Flow Pro\n\nReact Flow and Svelte Flow are open-source MIT-licensed libraries, and it will\nbe forever. Our libraries enable thousands of solo developers and organizations\nlike Stripe and Linkedin to build their node-based apps. With so many active\nusers, it takes time and effort to maintain the library, docs, and community.\nWe can’t do that without your support.\n\n[\u003cimg src=\"./assets/readme-pro.png\"\u003e](https://reactflow.dev/pro)\n\nWhy Subscribe? With your subscription, you are ensuring the sustainable\nmaintenance and development of both React Flow and Svelte Flow. This is how we\nmake sure these libraries stay MIT-licensed. In return, you get high-quality,\nmaintained, updated libraries, along with benefits like direct support,\nprioritized feature requests, and access to our Pro Examples.\n\n---\n\n## Contact us\n\nWe're happy to try and answer any questions you have about our libraries. We're\nalso always excited when folks want to share their projects with us. There are\na few ways you can get in touch:\n\n- Use the contact form on our [website](https://xyflow.com/contact).\n- Drop us an email at [info@xyflow.com](mailto:info@xyflow.com)\n- Join our [Discord server](https://discord.com/invite/RVmnytFmGW)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxyflow%2Fweb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxyflow%2Fweb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxyflow%2Fweb/lists"}