{"id":13423763,"url":"https://github.com/pankod/superplate","last_synced_at":"2025-05-14T07:09:08.484Z","repository":{"id":38034968,"uuid":"317859910","full_name":"pankod/superplate","owner":"pankod","description":" A well-structured production-ready frontend boilerplate with Typescript, React Testing Library, styled-component, React Query, .env, Axios, Bundle Analyzer, Prettier and 30+ plugins. superplate creates projects for React.js, Next.js, and refine. https://pankod.github.io/superplate/","archived":false,"fork":false,"pushed_at":"2024-05-08T11:30:38.000Z","size":11643,"stargazers_count":2871,"open_issues_count":29,"forks_count":155,"subscribers_count":28,"default_branch":"master","last_synced_at":"2025-05-11T16:46:23.376Z","etag":null,"topics":["best-practices","boilerplate","cli","nextjs","npx","react","reactjs","typescript"],"latest_commit_sha":null,"homepage":"https://pankod.github.io/superplate/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pankod.png","metadata":{"files":{"readme":"README.MD","changelog":null,"contributing":null,"funding":null,"license":null,"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,"publiccode":null,"codemeta":null}},"created_at":"2020-12-02T12:47:44.000Z","updated_at":"2025-05-11T14:51:04.000Z","dependencies_parsed_at":"2024-06-18T22:56:05.444Z","dependency_job_id":"08ad2f89-89b1-4fd6-b42b-2c64c15105e4","html_url":"https://github.com/pankod/superplate","commit_stats":{"total_commits":267,"total_committers":16,"mean_commits":16.6875,"dds":0.6704119850187267,"last_synced_commit":"4c699c2f6332d817ccde3cd74b945fa14a01df72"},"previous_names":[],"tags_count":78,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pankod%2Fsuperplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pankod%2Fsuperplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pankod%2Fsuperplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pankod%2Fsuperplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pankod","download_url":"https://codeload.github.com/pankod/superplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253600965,"owners_count":21934243,"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":["best-practices","boilerplate","cli","nextjs","npx","react","reactjs","typescript"],"created_at":"2024-07-31T00:00:41.931Z","updated_at":"2025-05-14T07:09:03.466Z","avatar_url":"https://github.com/pankod.png","language":"TypeScript","readme":"\u003cdiv align=\"center\"\u003e\n\u003cp align='center'\u003e\n\u003cimg src='images/cli.gif' width='500' alt='superplate example'\u003e\n\u003c/p\u003e\n\u003c/div\u003e\n\u003cbr/\u003e\n\u003cdiv align=\"center\"\u003eA well-structured production-ready frontend boilerplate with Typescript, React Testing Library, styled-component, React Query, .env, Axios, Bundle Analyzer, Prettier and \u003cb\u003e30+ plugins\u003c/b\u003e. \u003cdiv\u003e\u003cb\u003esuperplate\u003c/b\u003e creates ready-to-develop projects for React and Next.js and refine.\u003c/div\u003e\u003c/div\u003e\n\u003cbr/\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n\n\n[![Meercode CI Score](https://meercode.io/badge/pankod/superplate?type=ci-score\u0026branch=master\u0026token=2ZiT8YsoJgt57JB23NYwXrFY3rJHZboT\u0026lastDay=31)](https://meercode.io/)\n[![Meercode CI Success Rate](https://meercode.io/badge/pankod/superplate?type=ci-success-rate\u0026branch=master\u0026token=2ZiT8YsoJgt57JB23NYwXrFY3rJHZboT\u0026lastDay=31)](https://meercode.io/)\n[![Maintainability](https://api.codeclimate.com/v1/badges/eb4b5a8f88b6e511e61d/maintainability)](https://codeclimate.com/github/pankod/superplate/maintainability)\n[![npm version](https://img.shields.io/npm/v/superplate-cli.svg)](https://www.npmjs.com/package/superplate-cli)\n[![npm](https://img.shields.io/npm/dy/superplate-cli)](https://www.npmjs.com/package/superplate-cli)\n\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003csub\u003eCreated by \u003ca href=\"https://www.pankod.com\"\u003ePankod\u003c/a\u003e\u003c/sub\u003e\n\u003c/div\u003e\n\n\u003cbr/\u003e\n\n## About \n\n**superplate** lets you start rock-solid, production-ready _React_, _Next.JS_ and _refine_ projects just in seconds. The command-line interface guides the user through setup and no additional build configurations are required.\n\nSuperplate ships with +30 plugins including popular UI Kits, testing frameworks and many useful developer tools.\n\n## Quick Start\n\nTo use superplate, make sure you have _npx_ is installed on your system (npx is shipped by default since npm 5.2.0).\n\nTo create a new app without using presets, run the following command:\n\n```bash\nnpx superplate-cli my-project\n```\n\nYou will be prompted with plugin options to create your project. A full list of avaiable plugins is here: [superplate-core-plugins](https://github.com/pankod/superplate-core-plugins).\n\n## Available Integrations\n\n### Next.js \n\n\n\u003cdiv align=\"center\"\u003e \n\u003ca href=\"https://pankod.github.io/superplate/docs/\"\u003e\n  \u003cimg src=\"images/next-logo.png\"  width=\"75\" align=\"center\" /\u003e\n\u003c/a\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\n**superplate**  makes it easier to get up and running with a well-structured Next.js and TypeScript application.\n\n\n\nTo get started quickly, please run the following command. The CLI wizard will assist you for the rest of the setup process:\n\n```\nnpx superplate-cli -p nextjs my-project\n```\n\n### React.js \n\n\u003cdiv align=\"center\"\u003e \n\u003ca href=\"https://pankod.github.io/superplate/docs/\"\u003e\n  \u003cimg src=\"images/react-logo.png\"  width=\"75\" align=\"center\" /\u003e\n\u003c/a\u003e\n\u003c/div\u003e\n\n\u003cbr\u003e\n\n**superplate**  makes it easier to get up and running with a well-structured Create React App and TypeScript application.\n\nTo get started quickly, please run the following command. The CLI wizard will assist you for the rest of the setup process:\n\n```\nnpx superplate-cli -p react my-project\n```\n\n### refine ⚡\n[refine](https://github.com/pankod/refine) is an open source React framework for building **CRUD** apps rapidly.\n\n**superplate** provides built-in templates for CRA, Next.js and Remix environments so you can bootstrap a **refine** project in a couple of minutes. \n\n[Refer to refine repository for more information ➡️ ](https://github.com/pankod/refine)\n\n\u003cbr/\u003e\n\u003ca href=\"https://github.com/pankod/refine\"\u003e\n\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://user-images.githubusercontent.com/18739364/200257042-3f2aa7f7-a07f-4824-8d2a-b25f26b6fd32.png\"\u003e\n  \u003cimg alt=\"how-works-refine\" src=\"https://user-images.githubusercontent.com/18739364/200257209-8fc0c8b1-2568-453e-873f-00513434deed.png\"\u003e\n\u003c/picture\u003e\n\u003c/a\u003e\n\n\u003cbr/\u003e\n\u003cbr/\u003e\n\n\nTo get started quickly, please run the following command. The CLI wizard will assist you for the rest of the setup process:\n\n```\nnpx superplate-cli -p refine my-project\n```\n\n\u003cbr\u003e\n\n## Coming Soon\n\nWe are planning to add the following frameworks integrations soon.  \n\n\u003ca href=\"https://pankod.github.io/superplate/docs/\"\u003e\n  \u003cimg src=\"images/integrations.png\"  align=\"center\" /\u003e\n\u003c/a\u003e\n\n\u003cbr /\u003e\n\n## Documentation\n\nFor more detailed information and usage, you may refer to our [documentation pages](https://pankod.github.io/superplate/).\n\n\n## Philosophy\n\n-   It provides an easy starting to your project by leveraging industry-standard best practices and and performance oriented tools.\n-   Fully extensible due its plugin based architechture.\n-   Code examples are added to plugin documents to show how best practices are implemented.\n\n\n\n## Plugins\n\nsuperplate uses a plugin-based architecture. Basically, plugins are created from popular npm tools with configuration files. You can check them out in [superplate-core-plugins](https://github.com/pankod/superplate-core-plugins).\n\nThe default core plugins determined by \u003ca href=\"https://www.pankod.com\"\u003ePankod\u003c/a\u003e team. Feel free to send PR or open an issue for new plugins you want to add.\n\n### Using a custom source of plugins\n\nYou can use different sources for plugins other than [superplate-core-plugins](https://github.com/pankod/superplate-core-plugins).\n\nSimply add `--source \u003cpath-to-source\u003e` option to use **superplate** with a custom source.\n\nTo learn more about sources and how to create your own; please check out [documentation](https://pankod.github.io/superplate/docs/development/how-it-works/#creating-a-source-repository)\n\n### Creating a plugin\n\n**superplate** gives you many abilities to create your own plugin and interact with the others. To learn more on creating a plugin, please check out [documentation](https://pankod.github.io/superplate/docs/development/creating-a-plugin)\n\n## Available plugins\n\n\u003cimg src=\"images/plugins.png\"  align=\"center\" /\u003e\n\n## CLI options\n\n```\n\u003e npx superplate-cli --help\nUsage: superplate [options]\n\nOptions:\n -v, --version                   prints version number\n -h, --help                      prints help information on all commands and options\n -d, --debug                     prints additional logs\n -s, --source \u003cpath-to-source\u003e   Use this option to target a custom source of plugins\n                                 Source path can be a remote git repository or a local path.\n -p, --project \u003cproject-type\u003e    In sources with multiple types, you can use this option to preset the type.\n -b, --branch \u003cbranch-name\u003e      If your source is a git repository, you can define a custom branch for `superplate` to use.\n -o, --preset \u003cpreset-name\u003e      If your source includes presets, you can select one of them to prefill the answers.\n -l, --lucky                     You can select random choices with this option, if you are feeling lucky.\n```\n\n## Development mode commands\n\nWatches for changes in the code; builds the project and then globally installs superplate for testing.\n\n```\nnpm run dev:global\n```\n\nCreate a build inside `/lib` directory.\n\n```\nnpm run build:cli\n```\n\nInstall the current build globally:\n\n```\nnpm run global\n```\n\n## Contribution\n\nIf you have a bug to report, do not hesitate to file an issue.\n\nIf you are willing to fix an issue or propose a feature; all PRs with clear explanations are welcome and encouraged.\n\n## License\n\nLicensed under the MIT License, Copyright © 2021-present Pankod\n","funding_links":[],"categories":["Boilerplates","TypeScript","cli","Next.js boilerplate","Javascript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpankod%2Fsuperplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpankod%2Fsuperplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpankod%2Fsuperplate/lists"}