Skip to content

Latest commit

 

History

History
88 lines (68 loc) · 5.37 KB

README.md

File metadata and controls

88 lines (68 loc) · 5.37 KB
Raw

RemixKit

Remix development, streamlined with Vite.

An alternative dev server and compiler for the awesome Remix web framework.

Setup

> cd ./your-remix-app
> npx remix-kit@latest install

> npm run vite:dev

Please see the status section and getting started guide for details.

Features

  • Hot Module Replacement (HMR) for instant, precise updates on the browser and server without reloading the page or blowing away application state.
  • Instant development server startup, no pre-bundling required, scales to any project size.
  • Vite for development and build bundling. Includes vite-node for extremely fast targeted server code replacement. No purgeRequireCache needed, keep objects in-memory between requests to match production behavior.
  • Fully configurable & easily extensible
    • An extensible compiler and hooks system gives you complete control.
    • Use hooks from your own plugin modules to extend any part of the build process.
    • Benefit from the large ecosystem of vite plugins.
  • Easy to use CLI remix-kit for development, build, previews and more.
  • Seamless integration of Tailwind CSS with PostCSS. No need for multiple CLIs.
  • View library agnostic, with existing plugin for React.
  • Monorepo support, place your routes in libraries outside the main app to better separate your functionality amongst teams.
  • Integrated dotenv, bundle analysis, hierarchy based remix.config.js, file ignore with .remixignore and much more!

Status

(Alpha) Use to streamline your development but not recommended for production bundling use. Please help test and it can get there though.

Legend: ✅ (Tested),❓ (Untested), ⏳ (Not Supported)

Remix Template Status Install Notes
Remix App Server ✅ No changes required after install. Use the default remix-kit preview for the dev:server.
Express ✅ Rename the dev:node npm script to dev:server and delete the duplicate dev:server script. Add a require(BUILD_DIR); in the app.listen callback otherwise the first request will fail due to the dev client asynchronously initializing.
Fly ❓
Netlify ❓
Vercel ❓
Deno ❓
Cloudflare Workers ⏳
Cloudflare Pages ⏳

Packages

Package Changelog
remix-kit Changelog
@remix-kit/kit Changelog
@remix-kit/react Changelog
@remix-kit/schema Changelog
@remix-kit/vite Changelog

Contributing

See CONTRIBUTING.md for information on how to develop RemixKit locally.

Supporting RemixKit

RemixKit is an MIT-licensed open source project with its ongoing development made possible entirely by volunteer time. If you'd like to support this effort, please consider sponsoring.

Credit

This project was bootstrapped using code from Nuxt. Their MIT license can be found here and here. In addition it benefits greatly from a large number of libraries from the UnJS ecosystem. Vite and vite-node provide most of the core functionality and their usage is based on the approach pioneered by @pi0 and described in detail by @antfu at antfu.me.

License

MIT