Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Description / selection guide to the main README? #61

Open
fohrloop opened this issue Jan 15, 2025 · 0 comments
Open

Description / selection guide to the main README? #61

fohrloop opened this issue Jan 15, 2025 · 0 comments

Comments

@fohrloop
Copy link

fohrloop commented Jan 15, 2025

Thank you for this great project! Could the main README contain some common description to make it easier to grasp what the options are? I wrote some notes below.

Additional questions

I'm a rookie in the front end world, so could you please also enlighten me with: What is the practical difference of using "default" vs "node-custom-server"? I read from here that react-router-serve used in the default is just remix-serve (from Remix v2), and from here that

If you don't care to set up your own server, you can use remix-serve. It's a simple express-based server maintained by the Remix team. However, Remix is specifically designed to run in any JavaScript environment so that you own your stack. It is expected many —if not most— production apps will have their own server.

but could the README include what's the practical difference?


notes

Choosing a Template

  • General-purpose deployment: Use the default, node-postgres, or node-custom-server templates.
  • Service provider specific:
    • Cloudflare Workers: Use the cloudflare or cloudflare-d1 templates.
    • Netlify: Use the netlify template.
    • Vercel: Use the vercel template

Options

General-purpose deployment

For any platform supporting Docker, including:

  • AWS ECS
  • Google Cloud Run
  • Azure Container Apps
  • Digital Ocean App Platform
  • Fly.io
  • Railway

default

  • Typescript
  • Starts with: "react-router-serve ./build/server/index.js"

javascript

  • =same as default, but JavaScript instead of TypeScript

node-custom-server

  • Comes with a Node.js server using Express (server.js)

node-postgres

  • = Same as node-custom-server, but with database connections (PostgreSQL + DrizzleORM)

Service provider specific

cloudflare
  • Use Wrangler CLI to deploy to Couldflare Workers (serverless functions that run at the edge of Cloudflare's network.)
cloudflare-d1
  • = Same as cloudflare, but with database connections (D1 + DrizzleORM)
netlify
  • For deploying to netlify
vercel
  • For deploying to Vercel

Common Features

  • 🚀 Server-side rendering
  • ⚡️ Hot Module Replacement (HMR)
  • 📦 Asset bundling and optimization
  • 🔄 Data loading and mutations
  • 🔒 TypeScript by default (exception: "javascript")
  • 🎉 TailwindCSS for styling
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant