Skip to content

Commit 812cb2c

Browse files
Update README (#121)
* Add contributing section and list templates * Add descriptions for all of the official templates in the README * Add section on questions
1 parent ba784da commit 812cb2c

File tree

1 file changed

+106
-0
lines changed

1 file changed

+106
-0
lines changed

README.md

+106
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,109 @@ You can quickly create a new React Router application from any of these template
77
```bash
88
npx create-react-router@latest --template remix-run/react-router-templates/<template-name>
99
```
10+
11+
## Contributing
12+
13+
If you find a bug or want to make an improvement to one of the templates, please [create an issue](https://github.com/remix-run/react-router-templates/issues/new) or [create a PR](https://github.com/remix-run/react-router-templates/pulls).
14+
15+
### Contributing a new template
16+
17+
We intend to keep the number of templates in this repository to a minimum, and so will unlikely accept any new templates. The goal is for these templates to be a good starting point for many projects, as well as other community templates.
18+
19+
If you have a template you have developed and maintain, please submit a PR to add it to the [list below](#community-templates).
20+
21+
## Questions
22+
23+
If you have a question about React Router please open up a discussion on [GitHub Discussions](https://github.com/remix-run/react-router/discussions) or reach out on [Discord](https://rmx.as/discord).
24+
25+
## Templates
26+
27+
### Official Templates
28+
29+
The following templates are maintained by the React Router team. For more information on each template, checkout out the README of the template repository.
30+
31+
**Default template:**
32+
33+
A full-featured production-ready template with server-side rendering, TypeScript, TailwindCSS, and Docker support. Perfect for building scalable applications with built-in asset optimization and hot module replacement.
34+
35+
```bash
36+
npx create-react-router@latest
37+
```
38+
39+
**Minimal template:**
40+
41+
A lightweight template used for https://reactrouter.com/new. Designed for experimentation and demo applications. Not recommended for production use, but ideal for learning React Router's core concepts or creating reproductions.
42+
43+
```bash
44+
npx create-react-router@latest --template remix-run/react-router-templates/minimal
45+
```
46+
47+
**JavaScript only template:**
48+
49+
A TypeScript-free version of the default template, offering the same production-ready features but without type checking. Great for teams preferring plain JavaScript.
50+
51+
```bash
52+
npx create-react-router@latest --template remix-run/react-router-templates/javascript
53+
```
54+
55+
**Node custom server template:**
56+
57+
Extends the default template with a customizable Node.js server implementation, giving you full control over server configuration and middleware.
58+
59+
```bash
60+
npx create-react-router@latest --template remix-run/react-router-templates/node-custom-server
61+
```
62+
63+
**Node PostgreSQL template:**
64+
65+
Adds PostgreSQL database support with DrizzleORM to the default template, including database migrations and type-safe queries.
66+
67+
```bash
68+
npx create-react-router@latest --template remix-run/react-router-templates/node-postgres
69+
```
70+
71+
**Cloudflare template:**
72+
73+
Optimized for Cloudflare's edge platform with built-in deployment workflows using Wrangler CLI. Includes preview deployments and progressive rollouts.
74+
75+
```bash
76+
npx create-react-router@latest --template remix-run/react-router-templates/cloudflare
77+
```
78+
79+
**Cloudflare with D1 template:**
80+
81+
Extends the Cloudflare template with D1 database support, including migrations and production database setup. Perfect for edge-first applications with persistent data.
82+
83+
```bash
84+
npx create-react-router@latest --template remix-run/react-router-templates/cloudflare-d1
85+
```
86+
87+
**Vercel template:**
88+
89+
Pre-configured for Vercel deployment with optimized serverless functions and edge caching. Includes one-click deployment to Vercel's platform.
90+
91+
```bash
92+
npx create-react-router@latest --template remix-run/react-router-templates/vercel
93+
```
94+
95+
**Netlify template:**
96+
97+
Ready for Netlify deployment with serverless functions and edge caching. Features one-click deployment to Netlify's platform.
98+
99+
```bash
100+
npx create-react-router@latest --template remix-run/react-router-templates/netlify
101+
```
102+
103+
### Community Templates
104+
105+
The following templates are maintained by the community. For more information on each template, checkout out the README of the template repository.
106+
107+
If you have a template you have developed and maintain, please submit a PR to add it.
108+
109+
- [Epic Stack](https://github.com/epicweb-dev/epic-stack) - An opinionated project starter and reference that allows teams to ship their ideas to production faster and on a more stable foundation based on the experience of Kent C. Dodds and contributors.
110+
111+
- [Edge-first Starter Kit](https://github.com/edgefirst-dev/starter) - A full-stack starter kit for Edge-first applications built with React on top of Cloudflare Developer Platform.
112+
113+
- [react-router-nest](https://github.com/cbnsndwch/react-router-nest) - React Router 7 x NestJS custom server template for Turbo + PNPM monorepos.
114+
115+
- [Forge 42 base-stack](https://github.com/forge-42/base-stack) - A comprehensive React Router 7 template with React 19, TypeScript, TailwindCSS, Vite, Hono server, and built-in tools for testing, i18n, SEO, and development workflow.

0 commit comments

Comments
 (0)