LinuxmacOSWindows

Where Is the Remix Config File?

Remix reads remix.config.js at the project root for routes, server build, and future flags.

Last updated

Remix configures from remix.config.js at the project root. Ignored routes, the server build path, and dev port live there. Most projects set few keys because file based routing handles the rest.

Newer releases moved some options into Vite plugin settings, which splits answers by version. Check whether your project builds through the classic compiler or the Vite plugin first. The root file stays the entry point either way.

Where Remix stores this, by platform

Linux
[ProjectDir]/remix.config.js

Root config beside package.json. Route files live under app/routes by convention. Exact supported keys vary by Remix major version.

macOS
[ProjectDir]/remix.config.js

Same root file on Mac. Vite based projects split options with vite.config.ts. Keep both files in version control.

Windows
[ProjectDir]\remix.config.js

Same file on Windows. Build output defaults to public/build with server code beside it. Clean both folders for fresh builds.

Frequently asked questions

Where are Remix routes defined?

As files under app/routes by naming convention, not in the config. The config only tunes ignored patterns and build paths. Add a file to add a route.

Why do Remix config docs disagree?

Classic and Vite plugin eras moved options between remix.config.js and vite.config.ts. Match guides to your installed major version. The root config file itself never moved.

Notice an outdated path? Let us know.