When using create-remix to generate a new project, you can choose a Template or a Stack to quickly get up and running. Templates are minimal starting points to get you up and running. "Stacks" are templates that are more-complete and closer to production ready architectures (potentially including aspects such as testing, database, CI, and deployment configurations).
If you run create-remix without providing the --template option, you'll get a basic template using the Remix App Server.
npx create-remix@latest
If you are not interested in using TypeScript, you can install the simpler Javascript template instead:
npx create-remix@latest --template remix-run/remix/templates/remix-javascript
This is a great place to start if you're just looking to try out Remix for the first time. You can always extend this starting point yourself or migrate to a more advanced template later.
If you want more control over your server or wish to deploy to a non-node runtime—such as Arc, Cloudflare, or Deno—then you can try one of our [official templates][official-templates] from the Remix repository:
npx create-remix@latest --template remix-run/remix/templates/arc
npx create-remix@latest --template remix-run/remix/templates/cloudflare-pages
npx create-remix@latest --template remix-run/remix/templates/cloudflare-workers
npx create-remix@latest --template remix-run/remix/templates/deno
npx create-remix@latest --template remix-run/remix/templates/express
npx create-remix@latest --template remix-run/remix/templates/fly
Some hosting providers maintain their own Remix templates. For more information, see their official integration guides listed below.
We also provide a community-driven examples repository, with each example showcasing different Remix features, patterns, tools, hosting providers, etc. You can use these in a similar manner to install the working example:
npx create-remix@latest --template remix-run/examples/basic
When a template is closer to being a production-ready application, to the point that it provides opinions about the CI/CD pipeline, database and hosting platform, the Remix community refers to these templates as "stacks".
There are several official stacks provided, but you can also make your own (read more below).
Read the feature announcement blog post and watch Remix Stacks videos on YouTube.
The official stacks come ready with common things you need for a production application including:
What you're left with is everything completely set up for you to just get to work building whatever amazing web experience you want to build with Remix. Here are the official stacks:
You can use these stacks by proving the --template option when running create-remix, for example:
npx create-remix@latest --template remix-run/blues-stack
Yes, these are named after music genres. 🤘 Rock on.
You can browse the list of community stacks on GitHub.
Community stacks can be used by passing the GitHub username/repo combo to the --template option when running create-remix, for example:
npx create-remix@latest --template :username/:repo
If your template is in a private GitHub repo, you can pass a GitHub token via the --token option:
npx create-remix@latest --template your-private/repo --token yourtoken
The [token just needs repo access][repo-access-token].
You can provide a local directory or tarball on disk to the --template option, for example:
npx create-remix@latest --template /my/remix-stack
npx create-remix@latest --template /my/remix-stack.tar.gz
npx create-remix@latest --template /my/remix-stack.tgz
npx create-remix@latest --template file:///Users/michael/my-remix-stack.tar.gz
If you set any dependencies in package.json to *, the Remix CLI will change it to a semver caret of the installed Remix version:
- "remix": "*",
+ "remix": "^2.0.0",
This allows you to not have to regularly update your template to the latest version of that specific package. Of course, you do not have to put * if you'd prefer to manually manage the version for that package.
If the template has a remix.init/index.js file at the root then that file will be executed after the project has been generated and dependencies have been installed. This gives you a chance to do anything you'd like as part of the initialization of your template. For example, in the blues stack, the app property has to be globally unique, so we use the remix.init/index.js file to change it to the name of the directory that was created for the project + a couple random characters.
You could even use remix.init/index.js to ask further questions to the developer for additional configuration (using something like inquirer). Sometimes, you'll need dependencies installed to do this, but those deps are only useful during initialization. In that case, you can also create a remix.init/package.json with dependencies and the Remix CLI will install those before running your script.
After the init script has been run, the remix.init folder gets deleted, so you don't need to worry about it cluttering up the finished codebase.
remix.init script. To do so manually, they'll need to run remix init.
