├── .gitignore
├── README.md
├── app
├── entry.client.tsx
├── entry.server.tsx
├── root.tsx
├── routes
│ ├── 404.tsx
│ └── index.tsx
├── styles
│ ├── global.css
│ └── index.css
└── tsconfig.json
├── backend
├── config.arc
└── index.js
├── package.json
├── preferences.arc
├── public
└── favicon.ico
└── remix.config.js
/.gitignore:
--------------------------------------------------------------------------------
1 | /backend/build
2 | /public/build/
3 | node_modules/
4 |
5 | /.cache/
6 |
7 | sam.json
8 | sam.yaml
9 | package-lock.json
10 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | ## Please Don't Use
2 |
3 | > Please use `npm init remix` instead of this starter repo to create a new Remix app.
4 | > This repository was archived on April 29, 2021.
5 |
6 | # Remix Starter for Architect (AWS CloudFormation)
7 |
8 | Welcome to Remix!
9 |
10 | This is a starter repo for using [Remix](https://remix.run) with [Architect](http://arc.codes) (wrapper around AWS CloudFormation).
11 |
12 | ## Development
13 |
14 | When developing your app, you'll need two terminal tabs, one to run Architect's sandbox, and the other to run the Remix development server. In production, however, the Remix development server won't be used because your assets will be built and shipped with the server.
15 |
16 | First, `.npmrc.example` to `.npmrc` and insert the license key you get from [logging in to your dashboard at remix.run](https://remix.run/dashboard).
17 |
18 | > Note: if this is a public repo, you'll probably want to move the line with
19 | > your key into `~/.npmrc` to keep it private.
20 |
21 | Next, install all dependencies using `npm`:
22 |
23 | ```sh
24 | npm install
25 | ```
26 |
27 | Your `@remix-run/*` dependencies will come from the Remix package registry.
28 |
29 | ### Remix Development Server
30 |
31 | Once everything is installed, start the Remix asset server with the following command:
32 |
33 | ```sh
34 | npm run dev
35 | ```
36 |
37 | The dev server automatically rebuilds as your source files change.
38 |
39 | ### Architect Sandbox
40 |
41 | Architect recommends installing their CLI and the AWS sdk globally:
42 |
43 | ```sh
44 | $ npm i -g @architect/architect aws-sdk
45 | ```
46 |
47 | Now start the sandbox:
48 |
49 | ```sh
50 | $ arc sandbox
51 | ```
52 |
53 | You should now be able to visit http://localhost:3333.
54 |
55 | ## Deploying
56 |
57 | First, you'll need to have the AWS CLI installed, [here are the instructions](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html). Then follow the Architect setup instructions: https://arc.codes/docs/en/guides/get-started/detailed-aws-setup.
58 |
59 | Now you're ready to deploy. From the Remix http handler directory, build the app for production:
60 |
61 | ```sh
62 | $ npm run build
63 | ```
64 |
65 | And then from the root of the project, deploy with `arc`.
66 |
67 | ```sh
68 | $ arc deploy
69 | ```
70 |
71 | That's it!
72 |
73 | ## Documentation
74 |
75 | Detailed documentation for Remix [is available at remix.run](https://docs.remix.run).
76 |
--------------------------------------------------------------------------------
/app/entry.client.tsx:
--------------------------------------------------------------------------------
1 | import ReactDOM from "react-dom";
2 | import { RemixBrowser as Remix } from "@remix-run/react";
3 |
4 | ReactDOM.hydrate(
5 | // @types/react-dom says the 2nd argument to ReactDOM.hydrate() must be a
6 | // `Element | DocumentFragment | null` but React 16 allows you to pass the
7 | // `document` object as well. This is a bug in @types/react-dom that we can
8 | // safely ignore for now.
9 | // @ts-ignore
10 | ,
11 | document
12 | );
13 |
--------------------------------------------------------------------------------
/app/entry.server.tsx:
--------------------------------------------------------------------------------
1 | import ReactDOMServer from "react-dom/server";
2 | import { RemixServer as Remix } from "@remix-run/react";
3 | import type { EntryContext } from "@remix-run/node";
4 |
5 | export default function handleRequest(
6 | request: Request,
7 | responseStatusCode: number,
8 | responseHeaders: Headers,
9 | remixContext: EntryContext
10 | ) {
11 | let markup = ReactDOMServer.renderToString(
12 |
13 | );
14 |
15 | return new Response("" + markup, {
16 | status: responseStatusCode,
17 | headers: {
18 | ...Object.fromEntries(responseHeaders),
19 | "Content-Type": "text/html"
20 | }
21 | });
22 | }
23 |
--------------------------------------------------------------------------------
/app/root.tsx:
--------------------------------------------------------------------------------
1 | import type { LinksFunction, LoaderFunction } from "@remix-run/react";
2 | import { Meta, Links, Scripts, useRouteData } from "@remix-run/react";
3 | import { Outlet } from "react-router-dom";
4 |
5 | import stylesUrl from "./styles/global.css";
6 |
7 | export let links: LinksFunction = () => {
8 | return [{ rel: "stylesheet", href: stylesUrl }];
9 | };
10 |
11 | export let loader: LoaderFunction = () => {
12 | return { date: new Date() };
13 | };
14 |
15 | export default function App() {
16 | let data = useRouteData();
17 |
18 | return (
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
31 |
32 |
33 |
34 | );
35 | }
36 |
37 | export function ErrorBoundary({ error }: { error: Error }) {
38 | return (
39 |
40 |
41 |
42 | Oops!
43 |
44 |
45 |
46 |
App Error
47 |
{error.message}
48 |
49 | Replace this UI with what you want users to see when your app throws
50 | uncaught errors. The file is at app/App.tsx.
51 |
52 |
10 |
404
11 |
12 | );
13 | }
14 |
--------------------------------------------------------------------------------
/app/routes/index.tsx:
--------------------------------------------------------------------------------
1 | import type {
2 | MetaFunction,
3 | LinksFunction,
4 | LoaderFunction
5 | } from "@remix-run/react";
6 | import { useRouteData } from "@remix-run/react";
7 |
8 | import stylesUrl from "../styles/index.css";
9 |
10 | export let meta: MetaFunction = () => {
11 | return {
12 | title: "Remix Starter",
13 | description: "Welcome to remix!"
14 | };
15 | };
16 |
17 | export let links: LinksFunction = () => {
18 | return [{ rel: "stylesheet", href: stylesUrl }];
19 | };
20 |
21 | export let loader: LoaderFunction = () => {
22 | return { message: "this is awesome 😎" };
23 | };
24 |
25 | export default function Index() {
26 | let data = useRouteData();
27 |
28 | return (
29 |
30 |
Welcome to Remix!
31 |
32 | Check out the docs to get
33 | started.
34 |
35 |
Message from the loader: {data.message}
36 |