Skip to content

Commit

Permalink
feat: update homepage design
Browse files Browse the repository at this point in the history
  • Loading branch information
edmundhung committed Feb 11, 2024
1 parent 1bd0caa commit 194c8eb
Show file tree
Hide file tree
Showing 19 changed files with 470 additions and 424 deletions.
2 changes: 1 addition & 1 deletion .eslintrc.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"extends": ["@remix-run", "prettier"]
"extends": ["@remix-run", "prettier"]
}
1 change: 1 addition & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Prettier Configuration
# All supported options are listed here: https://prettier.io/docs/en/options.html
singleQuote: true
useTabs: true
42 changes: 9 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,41 @@
# remix-worker-template
# remix-cloudflare-template

Learn more about [Remix Stacks](https://remix.run/stacks).

```
npx create-remix --template edmundhung/remix-worker-template
npx create-remix --template edmundhung/remix-cloudflare-template
```

What's included?

- Deploying to [Cloudflare Workers](https://workers.cloudflare.com/)
- Supporting [Durable objects](https://developers.cloudflare.com/workers/learning/using-durable-objects) with [module workers](https://developers.cloudflare.com/workers/learning/migrating-to-module-workers/)
- CI/CD through [Github Actions](https://github.com/features/actions)
- Deploying to [Cloudflare Page](https://workers.cloudflare.com/)
- CI on [Github Actions](https://github.com/features/actions)
- Styling with [Tailwind](https://tailwindcss.com/)
- Testing with [Playwright](playwright.dev/) with _undici_ mocking support
- Testing using [Playwright](playwright.dev/) with _undici_ mocking support
- Code formatting with [Prettier](https://prettier.io)
- Linting with [ESLint](https://eslint.org)
- Static Types with [TypeScript](https://typescriptlang.org)

## Node Version

Please make sure the node version is **>= 16.7**. If you are using `nvm`, just run:

```sh
nvm use
```

This allows [miniflare](https://github.com/cloudflare/miniflare) to serve a development environment as close to the actual worker runtime as possibile.
Please make sure the node version is **>= 18**.

## Development

To starts your app in development mode, rebuilding assets on file changes, the recommended approach is:
To starts your app with the vite dev server, run the following command:

```sh
npm run dev
```

This will run your remix app in dev mode using miniflare.

## Testing

Before running the tests, please ensure the worker is built:
Before running the tests, please ensure the app is built:

```sh
npm run build && npm run test
```

## Deployment

To deploy your Remix app, simply do it with Wrangler using:

```sh
npx wrangler publish
```

## CI/CD

The template ships a [development workflow](./.github/workflows/development.yml) which is triggered whenever new changes are pushed.

To allow GitHub deploying the worker for you, following variables are required:

- CF_API_TOKEN
- CF_ACCOUNT_ID

These values could be found / created on your Cloudflare Dashboard
The template ships a [CI workflow](./.github/workflows/ci.yml) which is triggered whenever new changes are pushed.
30 changes: 30 additions & 0 deletions app/components.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import * as React from 'react';
import markdoc, { type RenderableTreeNodes } from '@markdoc/markdoc';

export function RemixLogo(props: React.ComponentPropsWithoutRef<'svg'>) {
return (
<svg
viewBox="0 0 659 165"
version="1.1"
xmlns="http://www.w3.org/2000/svg"
xmlnsXlink="http://www.w3.org/1999/xlink"
aria-labelledby="remix-run-logo-title"
role="img"
width="106"
height="30"
fill="currentColor"
{...props}
>
<title id="remix-run-logo-title">Remix Logo</title>
<path d="M0 161V136H45.5416C53.1486 136 54.8003 141.638 54.8003 145V161H0Z M133.85 124.16C135.3 142.762 135.3 151.482 135.3 161H92.2283C92.2283 158.927 92.2653 157.03 92.3028 155.107C92.4195 149.128 92.5411 142.894 91.5717 130.304C90.2905 111.872 82.3473 107.776 67.7419 107.776H54.8021H0V74.24H69.7918C88.2407 74.24 97.4651 68.632 97.4651 53.784C97.4651 40.728 88.2407 32.816 69.7918 32.816H0V0H77.4788C119.245 0 140 19.712 140 51.2C140 74.752 125.395 90.112 105.665 92.672C122.32 96 132.057 105.472 133.85 124.16Z" />
<path d="M229.43 120.576C225.59 129.536 218.422 133.376 207.158 133.376C194.614 133.376 184.374 126.72 183.35 112.64H263.478V101.12C263.478 70.1437 243.254 44.0317 205.11 44.0317C169.526 44.0317 142.902 69.8877 142.902 105.984C142.902 142.336 169.014 164.352 205.622 164.352C235.83 164.352 256.822 149.76 262.71 123.648L229.43 120.576ZM183.862 92.6717C185.398 81.9197 191.286 73.7277 204.598 73.7277C216.886 73.7277 223.542 82.4317 224.054 92.6717H183.862Z" />
<path d="M385.256 66.5597C380.392 53.2477 369.896 44.0317 349.672 44.0317C332.52 44.0317 320.232 51.7117 314.088 64.2557V47.1037H272.616V161.28H314.088V105.216C314.088 88.0638 318.952 76.7997 332.52 76.7997C345.064 76.7997 348.136 84.9917 348.136 100.608V161.28H389.608V105.216C389.608 88.0638 394.216 76.7997 408.04 76.7997C420.584 76.7997 423.4 84.9917 423.4 100.608V161.28H464.872V89.5997C464.872 65.7917 455.656 44.0317 424.168 44.0317C404.968 44.0317 391.4 53.7597 385.256 66.5597Z" />
<path d="M478.436 47.104V161.28H519.908V47.104H478.436ZM478.18 36.352H520.164V0H478.18V36.352Z" />
<path d="M654.54 47.1035H611.788L592.332 74.2395L573.388 47.1035H527.564L568.78 103.168L523.98 161.28H566.732L589.516 130.304L612.3 161.28H658.124L613.068 101.376L654.54 47.1035Z" />
</svg>
);
}

export function Markdown({ content }: { content: RenderableTreeNodes }) {
return <div className="prose">{markdoc.renderers.react(content, React)}</div>;
}
Loading

0 comments on commit 194c8eb

Please sign in to comment.