{"id":19122554,"url":"https://github.com/vulcanjs/vulcan-next","last_synced_at":"2025-04-06T09:09:05.485Z","repository":{"id":37879857,"uuid":"242775289","full_name":"VulcanJS/vulcan-next","owner":"VulcanJS","description":"The Next starter for GraphQL developers","archived":false,"fork":false,"pushed_at":"2023-10-03T00:31:32.000Z","size":10068,"stargazers_count":396,"open_issues_count":71,"forks_count":30,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-03-30T08:07:55.589Z","etag":null,"topics":["graphql","hacktoberfest","nextjs","vercel","vulcan"],"latest_commit_sha":null,"homepage":"http://vulcan-docs.vercel.app","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/VulcanJS.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","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}},"created_at":"2020-02-24T15:44:21.000Z","updated_at":"2025-01-20T09:54:19.000Z","dependencies_parsed_at":"2024-02-17T08:44:51.055Z","dependency_job_id":null,"html_url":"https://github.com/VulcanJS/vulcan-next","commit_stats":null,"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VulcanJS%2Fvulcan-next","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VulcanJS%2Fvulcan-next/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VulcanJS%2Fvulcan-next/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VulcanJS%2Fvulcan-next/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VulcanJS","download_url":"https://codeload.github.com/VulcanJS/vulcan-next/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247457803,"owners_count":20941906,"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":["graphql","hacktoberfest","nextjs","vercel","vulcan"],"created_at":"2024-11-09T05:21:58.895Z","updated_at":"2025-04-06T09:09:05.464Z","avatar_url":"https://github.com/VulcanJS.png","language":"TypeScript","readme":"# Vulcan Next\n\nVulcan Next helps you build GraphQL-based applications with Next.js.\n\n\u003cpicture\u003e\n  \u003csource\n   srcSet=\"https://raw.githubusercontent.com/VulcanJS/vulcan-next/devel/public/img/vn-logo-full-padded-dark-840.png\"\n    media=\"(prefers-color-scheme: dark)\"/\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/VulcanJS/vulcan-next/devel/public/img/vn-logo-full-padded-840.png\" alt=\"vulcan-next banner\" /\u003e\n\u003c/picture\u003e\n\n## What's in the box?\n\nWhere Vulcan Next shines:\n\n- B2B SaaS software, CMS, platforms\n- Apps that rely a lot on CRUD operations (managing and listing data structure, like in a CMS)\n- APIs that can be consumed by multiple clients (your own app but also a mobile version, data scientists, other 3rd party apps...)\n\nVulcan Next provides:\n\n- A production-grade Next.js + Apollo GraphQL boilerplate. \n- A GraphQL API endpoint set up with Apollo Server and a Mongo connector, so you can start coding back-end features immediately.\n- Development tooling such as Cypress, Jest, Storybook... and many others.\n- Schema-based helpers and hooks to quickly generate and consume your own GraphQL API\n- Password based authentication with Passport\n\n[Join the Slack and meet Vulcan contributors](http://slack.vulcanjs.org/)\n\n[Join the new Discord and meet Vulcan contributors](https://discord.gg/4dqeKSNv)\n\n[Get started with the live tutorial](https://vulcan-next.vercel.app/learn)\n\n[Read the introductory article on FreeCodeCamp](https://www.freecodecamp.org/news/how-to-replace-meteor-by-next-introducing-vulcan-next-starter/)\n\n[Check the full documentation](https://vulcan-docs.vercel.app)\n\n## A word about the core team and sponsoring\n\nYou can't teach an old dog new tricks! Vulcan Next is the successor of \"Vulcan.js\", the Meteor framework from [Sacha Greif](https://sachagreif.com/). It inherits years of experience, with a modernized architecture that replaces Meteor by Next.js.\n\nVulcan Next powers the [Devographics](https://www.devographics.com/) surveys [State of JS](https://stateofjs.com/), [State of CSS](https://stateofcss.com/) and [State of GraphQL](https://www.stateofgraphql.com/).\n\n**Not familiar with Next.js yet?** You can join the [Next.js course at Human Coders](https://www.humancoders.com/formations/next-js-en) from [Eric Burel](https://twitter.com/ericbureltech), 3 days to understand the inner workings of Next.js router, server and static rendering, edge middlewares and all their friends.\n\n**Want to help us building high quality boilerplates?** You can sponsor Vulcan on [Open Collective](https://opencollective.com/vulcan) or reach us out for bounties and freelance work (ping us on Vulcan slack or Discord).\n\n---\n\n## Install and run in 5 minutes\n\n**Pro tip:** you can test Vulcan Next with zero install by cloning it on [CodeSandbox](https://projects.codesandbox.io/).\n\nIf you prefer a local install:\n\n```sh\ngit clone -b main https://github.com/VulcanJS/vulcan-next\ncd vulcan-next\nyarn\nyarn run dev\n```\n\nOpen [http://localhost:3000](http://localhost:3000) in your browser.\nYou can then access the live tutorial on [http://localhost:3000/learn](http://localhost:3000/learn).\n\n---\n\n## Next steps\n\n### Setup your own git repository\n\nWhen creating your own application, you'll want to host the code on your own Git repository (on GitHub, BitBucket, etc.).\n\n#### Point git to your own repository\n\nRename \"origin\" to \"upstream\", so you can use your own git repository as the main \"origin\", and VN official repo as \"upstream\".\n\n```sh\ngit remote rename origin upstream\n# Then do what you need to create your own origin remote\n# git remote add origin \u003cyour-own-git-repository-url\u003e\n```\n\n### Roll your own Mongo database\n\nAs a default, Vulcan Next will connect to a sample read-only database owned by LBKE.\nTo create your own application, you'll want to use your own databse.\n\n#### 0. I am a Windows user (if using Mac or Linux skip to 1.)\n\nIf you use Windows, you might want to either:\n\n- Install [Ubuntu as a dual boot](https://help.ubuntu.com/community/WindowsDualBoot) (virtual machine are technically fine but way slower and could lead to a poor development experience)\n- Setup the [Linux subsystem](https://docs.microsoft.com/fr-fr/windows/wsl/install) in order to be able to run [Docker on Windows](https://docs.docker.com/desktop/windows/wsl/)\n\n- Install MongoDB using the [Windows installer](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-windows/)\n\n#### 1. Run a Mongo server using Docker\n\nIt will run Mongo in your current terminal, or create and run a Mongo image if it's the first time your run the command.\n\n**Note:** you should always start your database *before* you run the application.\n\n```sh\nyarn run start:mongo\n```\n\n[**See Docker installation instruction for Ubuntu here**](https://docs.docker.com/engine/install/ubuntu/) if you don't have Docker yet.\n\n#### 2. Configure your application to use your local database\n\nIn `.env.development` or `.env.development.local` use this URI for Mongo:\n\n```sh\nMONGO_URI=\"mongodb://localhost:27017/vulcan-next-app\"\n```\n\nYou can then stop the server and start it again.\n\nWe advise to use [MongoDB Compass](https://www.mongodb.com/try/download/compass) to visualize your database content.\n\n### Update your app to the latest version of Vulcan Next\n\n**Beware:** Vulcan Next is a boilerplate, the possibility to update automatically is not guaranteed. You may\nhave to apply the updates by hand, comparing Vulcan Next latest version to your own code. **Always double-check that the merge didn't break your app!**.\n\n```sh\n# Get the latest version of Vulcan Next locally\ngit fetch upstream\n# Merge to your own code (favouring your own code as a default in case of conflict)\ngit merge upstream/main -X ours\n```\n\n---\n\n## Contribute or raise an issue\n\nThis starter is **read-only**! Please avoid opening pull requests against it.\n\nAll developments [happen in our monorepo \"Vulcan NPM\" here.](https://github.com/VulcanJS/vulcan-npm)\n\n---\n\n## They support Vulcan Next and Vulcan Meteor\n\n### Contributors\n\nThis project exists thanks to all the people who contribute.\n\n\u003ca href=\"https://github.com/VulcanJS/vulcan-next/graphs/contributors\"\u003e\u003cimg src=\"https://opencollective.com/vulcan/contributors.svg?width=890\u0026button=false\" /\u003e\u003c/a\u003e\n\n### Backers\n\nThank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/vulcan#contribute)]\n\n\u003ca href=\"https://opencollective.com/vulcan#contributors\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/vulcan/backers.svg?width=890\"/\u003e\u003c/a\u003e\n\n### Sponsors\n\nSupport this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/vulcan#contribute)]\n\n\u003ca href=\"https://opencollective.com/vulcan#contributors\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/vulcan/sponsors.svg?width=890\"/\u003e\u003c/a\u003e\n\n### Technical supports\n\nThey give time and share knowledge to support the project.\n\n\u003ca href=\"https://aplines.com\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n\u003cimg src=\"https://aplines.com/wp-content/uploads/2022/03/cropped-aplines-logo.png\" alt=\"aplines\" height=\"75\"/\u003e\n\u003c/a\u003e\n\u003ca href=\"https://www.lbke.fr\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n\u003cimg src=\"https://www.lbke.fr/img/logo-md.png\" height=\"75\" alt=\"lbke\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://letter.so/\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n\u003cimg src=\"https://github.com/VulcanJS/vulcan-next/blob/devel/public/img/letter-96x96.png?raw=true\" height=\"75\" alt=\"lette.so\" /\u003e\n\u003c/a\u003e\n\n## Other cool Next stuff\n\n- [Official Apollo example from Next](https://github.com/zeit/next.js/tree/canary/examples/with-apollo)\n- [Next Right Now](https://github.com/UnlyEd/next-right-now) (a complete Next Starter, relying on Prisma cloud solutions for the backend)\n- [Blitz](https://blitzjs.com/) (fullstack Next without GraphQL)\n- [Next Antd Graphql Starter](https://github.com/clement-faure/next-antd-graphql-starter)\n- [Next React Graphql Apollo Bootstrap](https://github.com/Sebastp/Next-react-graphql-apollo_Boostrap)\n- [Next advanced starter](https://github.com/borisowsky/next-advanced-starter),\n- [Next - Mongo](https://github.com/hoangvvo/nextjs-mongodb-app) (no Express, no GraphQL, just Next and Mongo)\n- [Next and TypeScript from the maker of next-transpile-modules](https://github.com/martpie/monorepo-typescript-next-the-sane-way)\n- [A frontend performance oriented starter](https://github.com/ixartz/Next-js-Boilerplate)\n- [Bison, a full-stack Next.js starter](https://github.com/echobind/bisonapp)\n- [Nextra](https://github.com/shuding/nextra), a no-code site generator with Markdown (great for blogging)\n- [BlueLibs](https://www.bluelibs.com/docs/), a toolkit that also proposes a React starter\n\n---\n\n## About Next.js\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## 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---\n\n## Deploy on Vercel\n\nThe easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template\u0026filter=next.js\u0026utm_source=vulcan\u0026utm_campaign=oss) from the creators of Next.js.\n\nCheck out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.\n\n[![Powered by Vercel](https://www.datocms-assets.com/31049/1618983297-powered-by-vercel.svg)](https://vercel.com?utm_source=vulcan\u0026utm_campaign=oss)\n","funding_links":["https://opencollective.com/vulcan"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvulcanjs%2Fvulcan-next","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvulcanjs%2Fvulcan-next","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvulcanjs%2Fvulcan-next/lists"}