https://github.com/willklein/remix-netlify-testing
https://github.com/willklein/remix-netlify-testing
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/willklein/remix-netlify-testing
- Owner: willklein
- Created: 2023-12-03T03:51:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-03T03:52:04.000Z (over 2 years ago)
- Last Synced: 2025-02-16T14:01:06.590Z (over 1 year ago)
- Language: TypeScript
- Size: 196 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Welcome to Remix!
- [Remix Docs](https://remix.run/docs)
- [Netlify Edge Functions Overview](https://docs.netlify.com/edge-functions/overview/)
## Netlify Setup
1. Install the [Netlify CLI](https://docs.netlify.com/cli/get-started/):
```sh
npm i -g netlify-cli
```
If you have previously installed the Netlify CLI, you should update it to the latest version:
```sh
npm i -g netlify-cli@latest
```
2. Sign up and log in to Netlify:
```sh
netlify login
```
3. Create a new site:
```sh
netlify init
```
## Development
Ensure all packages are installed by running:
```sh
npm install
```
Run
```sh
npm run dev
```
Open up [http://localhost:8888](http://localhost:8888), and you're ready to go!
### Serve your site locally
To serve your site locally in a production-like environment, run
```sh
npm run start
```
Your site will be available at [http://localhost:8888](http://localhost:8888). Note that it will not auto-reload when you make changes.
## Excluding routes
You can exclude routes for non-Remix code such as custom Netlify Functions or Edge Functions. To do this, add an additional entry in the array like in the example below:
```diff
export const config = {
cache: "manual",
path: "/*",
// Let the CDN handle requests for static assets, i.e. /_assets/*
//
// Add other exclusions here, e.g. "/api/*" for custom Netlify functions or
// custom Netlify Edge Functions
- excluded_patterns: ["/_assets/*"],
+ excluded_patterns: ["/_assets/*", "/api/*"],
};
```
## 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:
```sh
# preview deployment
netlify deploy --build
# production deployment
netlify deploy --build --prod
```