https://github.com/netlify/remix-template
Deploy your Remix site to Netlify
https://github.com/netlify/remix-template
edge-functions netlify remix remix-run serverless-functions
Last synced: 5 days ago
JSON representation
Deploy your Remix site to Netlify
- Host: GitHub
- URL: https://github.com/netlify/remix-template
- Owner: netlify
- Created: 2022-04-19T14:24:48.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-25T21:18:25.000Z (7 months ago)
- Last Synced: 2025-03-21T13:53:58.574Z (about 1 month ago)
- Topics: edge-functions, netlify, remix, remix-run, serverless-functions
- Language: JavaScript
- Homepage:
- Size: 1.79 MB
- Stars: 87
- Watchers: 5
- Forks: 28
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Netlify Remix Template
Welcome to the Netlify Remix Template project. If you were expecting this to be your site, run `remix init` in the root of this project to get started.
To use the template, run
```bash
npx create-remix@latest --template netlify/remix-template
```
This project includes:
- Netlify Functions template for Remix sites
- Netlify Edge Functions template for Remix sites
From the `create-remix` command, you may pass `--netlify-edge` or `--no-netlify-edge` to generate a template that uses Netlify Edge or Serverless functions explicitly. Without passing this option, the create workflow will ask you which you would prefer.
## Development
There is no need to run `npm install` as this is a template. The Remix CLI will install the dependencies for you. Make changes to files as you see fit. If there are transformations for files for either the Netlify Functions or Netlify Edge Functions template, make the appropriate changes to the `remix.init/index.js` file.
If you're new to Remix stacks and the remix.init concept, see the official [Remix Stacks](https://remix.run/stacks) documentation.
### Testing your changes
Run
```bash
npx create-remix@latest --template ./remix-template
```
to test your changes to the template. Follow the steps the Remix CLI prompts you with to create a new project. Ensure to test for both the Netlify Functions template and the Netlify Edge Functions template.