Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing kitchen-sink example. #8600

Merged
merged 12 commits into from
Jun 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 1 addition & 81 deletions examples/kitchen-sink/apps/blog/.eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -1,84 +1,4 @@
/**
* This is intended to be a basic starting point for linting in your app.
* It relies on recommended configs out of the box for simplicity, but you can
* and should modify this configuration to best suit your team's needs.
*/

/** @type {import('eslint').Linter.Config} */
module.exports = {
root: true,
parserOptions: {
ecmaVersion: "latest",
sourceType: "module",
ecmaFeatures: {
jsx: true,
},
},
env: {
browser: true,
commonjs: true,
es6: true,
},
ignorePatterns: ["!**/.server", "!**/.client"],

// Base config
extends: ["eslint:recommended"],

overrides: [
// React
{
files: ["**/*.{js,jsx,ts,tsx}"],
plugins: ["react", "jsx-a11y"],
extends: [
"plugin:react/recommended",
"plugin:react/jsx-runtime",
"plugin:react-hooks/recommended",
"plugin:jsx-a11y/recommended",
],
settings: {
react: {
version: "detect",
},
formComponents: ["Form"],
linkComponents: [
{ name: "Link", linkAttribute: "to" },
{ name: "NavLink", linkAttribute: "to" },
],
"import/resolver": {
typescript: {},
},
},
},

// Typescript
{
files: ["**/*.{ts,tsx}"],
plugins: ["@typescript-eslint", "import"],
parser: "@typescript-eslint/parser",
settings: {
"import/internal-regex": "^~/",
"import/resolver": {
node: {
extensions: [".ts", ".tsx"],
},
typescript: {
alwaysTryTypes: true,
},
},
},
extends: [
"plugin:@typescript-eslint/recommended",
"plugin:import/recommended",
"plugin:import/typescript",
],
},

// Node
{
files: [".eslintrc.cjs"],
env: {
node: true,
},
},
],
extends: ["@remix-run/eslint-config", "@remix-run/eslint-config/node"],
};
2 changes: 1 addition & 1 deletion examples/kitchen-sink/apps/blog/.gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
node_modules

/.cache
/build
.env
.vercel
44 changes: 21 additions & 23 deletions examples/kitchen-sink/apps/blog/README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,38 @@
# Welcome to Remix!
# Remix

- 📖 [Remix docs](https://remix.run/docs)
This directory is a brief example of a [Remix](https://remix.run/docs) site that can be deployed to Vercel with zero configuration.

## Development

Run the dev server:
To get started, run the Remix cli with this template

```shellscript
npm run dev
```sh
npx create-remix@latest --template vercel/vercel/examples/remix
```

## Deployment
## Deploy Your Own

First, build your app for production:
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/vercel/vercel/tree/main/examples/remix&template=remix)

```sh
npm run build
```
_Live Example: https://remix-run-template.vercel.app_

Then run the app in production mode:
You can also deploy using the [Vercel CLI](https://vercel.com/docs/cli):

```sh
npm start
npm i -g vercel
vercel
```

Now you'll need to pick a host to deploy it to.

### DIY
## Development

If you're familiar with deploying Node applications, the built-in Remix app server is production-ready.
To run your Remix app locally, make sure your project's local dependencies are installed:

Make sure to deploy the output of `npm run build`
```sh
npm install
```

- `build/server`
- `build/client`
Afterwards, start the Remix development server like so:

## Styling
```sh
npm run dev
```

This template comes with [Tailwind CSS](https://tailwindcss.com/) already configured for a simple default starting experience. You can use whatever css framework you prefer. See the [Vite docs on css](https://vitejs.dev/guide/features.html#css) for more information.
Open up [http://localhost:5173](http://localhost:5173) and you should be ready to go!
18 changes: 0 additions & 18 deletions examples/kitchen-sink/apps/blog/app/entry.client.tsx

This file was deleted.

140 changes: 0 additions & 140 deletions examples/kitchen-sink/apps/blog/app/entry.server.tsx

This file was deleted.

4 changes: 3 additions & 1 deletion examples/kitchen-sink/apps/blog/app/root.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ import {
Scripts,
ScrollRestoration,
} from "@remix-run/react";
import "./tailwind.css";
import { Analytics } from "@vercel/analytics/react";
import "./styles.css";

export function Layout({ children }: { children: React.ReactNode }) {
return (
Expand All @@ -20,6 +21,7 @@ export function Layout({ children }: { children: React.ReactNode }) {
{children}
<ScrollRestoration />
<Scripts />
<Analytics />
</body>
</html>
);
Expand Down
15 changes: 15 additions & 0 deletions examples/kitchen-sink/apps/blog/app/routes/edge.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import type { MetaFunction } from "@vercel/remix";

export const config = { runtime: "edge" };

export const meta: MetaFunction = () => [
{ title: "Remix@Edge | New Remix App" },
];

export default function Edge() {
return (
<div style={{ fontFamily: "system-ui, sans-serif", lineHeight: "1.4" }}>
<h1>Welcome to Remix@Edge</h1>
</div>
);
}
Loading
Loading