Skip to content

Latest commit

 

History

History
70 lines (47 loc) · 2.16 KB

README.md

File metadata and controls

70 lines (47 loc) · 2.16 KB
Raw

Warning
The @remix-run/netlify runtime adapter has been deprecated in favor of @netlify/remix-adapter and will be removed in Remix v2. Please update your code by changing all @remix-run/netlify imports to @netlify/remix-adapter.
Keep in mind that @netlify/remix-adapter requires @netlify/functions@^1.0.0, which is a breaking change compared to the current supported @netlify/functions versions in @remix-run/netlify.

Welcome to Remix!

Netlify Setup

  1. Install the Netlify CLI:
npm i -g netlify-cli

If you have previously installed the Netlify CLI, you should update it to the latest version:

npm i -g netlify-cli@latest
  1. Sign up and log in to Netlify:
netlify login
  1. Create a new site:
netlify init

Development

The Remix dev server starts your app in development mode, rebuilding assets on file changes. To start the Remix dev server:

npm run dev

Open up http://localhost:3000, and you should be ready to go!

The Netlify CLI builds a production version of your Remix App Server and splits it into Netlify Functions that run locally. This includes any custom Netlify functions you've developed. The Netlify CLI runs all of this in its development mode.

netlify dev

Open up http://localhost:3000, and you should be ready to go!

Note: When running the Netlify CLI, file changes will rebuild assets, but you will not see the changes to the page you are on unless you do a browser refresh of the page. Due to how the Netlify CLI builds the Remix App Server, it does not support hot module reloading.

Deployment

There are two ways to deploy your app to Netlify, you can either link your app to your git repo and have it auto deploy changes to Netlify, or you can deploy your app manually. If you've followed the setup instructions already, all you need to do is run this:

# preview deployment
netlify deploy --build

# production deployment
netlify deploy --build --prod