https://github.com/msutkowski/remix-yarn2-test
A quick example of running remix.run with yarn2
https://github.com/msutkowski/remix-yarn2-test
Last synced: about 1 year ago
JSON representation
A quick example of running remix.run with yarn2
- Host: GitHub
- URL: https://github.com/msutkowski/remix-yarn2-test
- Owner: msutkowski
- Created: 2021-06-29T16:23:01.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-06-29T16:23:44.000Z (almost 5 years ago)
- Last Synced: 2025-03-25T04:04:17.351Z (over 1 year ago)
- Language: TypeScript
- Size: 41 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### Overview
This repo uses yarn2 without PnP. You can see the config in `yarnrc.yml`.
You'll need to run `yarn install` with dotenv cli or prefixing it with the env var.
```sh
cp env.example .env
# set your token in your .env
dotenv yarn install # or you can run: REMIX_AUTH_TOKEN=YOURTOKEN yarn install
yarn dev
```
---
# Welcome to Remix!
- [Remix Docs](https://docs.remix.run)
- [Customer Dashboard](https://remix.run/dashboard)
## Vercel Setup
First you'll need the [Vercel CLI](https://vercel.com/docs/cli):
```sh
npm i -g vercel
```
Before you can run the app in development, you need link this project to a new Vercel project on your account.
**It is important that you use a new project. If you try to link this project to an existing project (like a Next.js site) you will have problems.**
```sh
$ vercel link
```
Follow the prompts, and when its done you should be able to get started.
## Development
You will be running two processes during development when using Vercel as your server.
- Your Vercel server in one
- The Remix development server in another
```sh
# in one tab
$ vercel dev
# in another
$ npm run dev
```
Open up [http://localhost:3000](http://localhost:3000) and you should be ready to go!
If you'd rather run everything in a single tab, you can look at [concurrently](https://npm.im/concurrently) or similar tools to run both processes in one tab.
## Deploying
You will need to add your npmrc with your Remix token to your server's environment:
When you ran `npm init remix`, we probably created an npmrc in your home directory. Go take a look, it should look something like this:
```
//npm.remix.run/:_authToken={your-token}
@remix-run:registry=https://npm.remix.run
```
If it looks something like that, then you can run these commands to add your npmrc from the command line:
```bash
$ vercel env add NPM_RC development < ~/.npmrc
$ vercel env add NPM_RC preview < ~/.npmrc
$ vercel env add NPM_RC production < ~/.npmrc
```
You can also add this environment variable in your vercel project dashboard.
Once that's done you can deploy!
```sh
$ npm run build
# preview deployment
$ vercel
# production deployment
$ vercel --prod
```
### GitHub Automatic Deployments
For some reason the GitHub integration doesn't deploy the public folder. We're working with Vercel to figure this out.
For now, [you can set up a GitHub action with this config](https://gist.github.com/mcansh/91f8effda798b41bb373351fad217070) from our friend @mcansh.