|
1 | | -# Remix Grunge Stack |
| 1 | +# r2dliu.com - Personal Website |
2 | 2 |
|
3 | | - |
| 3 | +A personal website showcasing projects, articles, and interactive experiences, built with modern web technologies and deployed on Google Cloud infrastructure. |
4 | 4 |
|
5 | | -Learn more about [Remix Stacks](https://remix.run/stacks). |
| 5 | +## Architecture Overview |
6 | 6 |
|
7 | | -``` |
8 | | -npx create-remix@latest --template remix-run/grunge-stack |
9 | | -``` |
| 7 | +This project has evolved quite a lot over the years. The progression looked something like this: |
10 | 8 |
|
11 | | -## What's in the stack |
| 9 | +- **Raw HTML/CSS/JS** → **Create React App** → **Remix** → **TanStack Start** |
12 | 10 |
|
13 | | -- [AWS deployment](https://aws.com) with [Architect](https://arc.codes/) |
14 | | -- Production-ready [DynamoDB Database](https://aws.amazon.com/dynamodb/) |
15 | | -- [GitHub Actions](https://github.com/features/actions) for deploy on merge to production and staging environments |
16 | | -- Email/Password Authentication with [cookie-based sessions](https://remix.run/docs/en/v1/api/remix#createcookiesessionstorage) |
17 | | -- DynamoDB access via [`arc.tables`](https://arc.codes/docs/en/reference/runtime-helpers/node.js#arc.tables) |
18 | | -- Styling with [Tailwind](https://tailwindcss.com/) |
19 | | -- End-to-end testing with [Cypress](https://cypress.io) |
20 | | -- Local third party request mocking with [MSW](https://mswjs.io) |
21 | | -- Unit testing with [Vitest](https://vitest.dev) and [Testing Library](https://testing-library.com) |
22 | | -- Code formatting with [Prettier](https://prettier.io) |
23 | | -- Linting with [ESLint](https://eslint.org) |
24 | | -- Static Types with [TypeScript](https://typescriptlang.org) |
| 11 | +The current stack represents a fully type-safe, server-side rendered, React application with scalable full-stack capabilities. It's nearly completely free to host, too; I only pay pennies a month to keep this thing afloat. |
25 | 12 |
|
26 | | -Not a fan of bits of the stack? Fork it, change it, and use `npx create-remix --template your/repo`! Make it your own. |
| 13 | +## Tech Stack |
27 | 14 |
|
28 | | -## Development |
| 15 | +### Frontend (React) |
| 16 | +- **[TanStack Start](https://tanstack.com/start)**: Full-stack React framework with SSR, file-based routing, and built-in data loading |
| 17 | +- **React Three Fiber**: 3D graphics and interactive experiences using Three.js |
| 18 | +- **TypeScript**: Full type safety across the entire application |
| 19 | +- **Vite**: Fast build tool and development server |
| 20 | +- **Tailwind CSS**: Utility-first styling |
29 | 21 |
|
30 | | -- This step only applies if you've opted out of having the CLI install dependencies for you: |
| 22 | +### Backend (Python) |
| 23 | +- **uv**: Blows everything else out of the water |
| 24 | +- **Django**: A tried and true classic |
| 25 | +- **Supabase**: The only "free" db hosting |
| 26 | +- **GraphQL**: Powered by Graphene |
31 | 27 |
|
32 | | - ```sh |
33 | | - npx remix init |
34 | | - ``` |
| 28 | +### Infrastructure |
| 29 | +- **Google Cloud Run**: Serverless container deployment for both frontend and backend |
| 30 | +- **Google Cloud Build**: CI/CD pipeline for automatic deployments |
| 31 | +- **AWS Route53 / Cloudflare**: DNS and route management |
| 32 | +- **Docker**: Containerization for consistent deployments |
35 | 33 |
|
36 | | -- Validate the app has been set up properly (optional): |
| 34 | +## Features |
37 | 35 |
|
38 | | - ```sh |
39 | | - npm run validate |
40 | | - ``` |
41 | | - |
42 | | -- Start dev server: |
43 | | - |
44 | | - ```sh |
45 | | - npm run dev |
46 | | - ``` |
47 | | - |
48 | | -This starts your app in development mode, rebuilding assets on file changes. |
49 | | - |
50 | | -### Relevant code: |
51 | | - |
52 | | -This is a pretty simple note-taking app, but it's a good example of how you can build a full stack app with Architect and Remix. The main functionality is creating users, logging in and out, and creating and deleting notes. |
53 | | - |
54 | | -- creating users, and logging in and out [./app/models/user.server.ts](./app/models/user.server.ts) |
55 | | -- user sessions, and verifying them [./app/session.server.ts](./app/session.server.ts) |
56 | | -- creating, and deleting notes [./app/models/note.server.ts](./app/models/note.server.ts) |
57 | | - |
58 | | -The database that comes with `arc sandbox` is an in memory database, so if you restart the server, you'll lose your data. The Staging and Production environments won't behave this way, instead they'll persist the data in DynamoDB between deployments and Lambda executions. |
59 | | - |
60 | | -## Deployment |
61 | | - |
62 | | -This Remix Stack comes with two GitHub Actions that handle automatically deploying your app to production and staging environments. By default, Arc will deploy to the `us-west-2` region, if you wish to deploy to a different region, you'll need to change your [`app.arc`](https://arc.codes/docs/en/reference/project-manifest/aws) |
63 | | - |
64 | | -Prior to your first deployment, you'll need to do a few things: |
65 | | - |
66 | | -- Create a new [GitHub repo](https://repo.new) |
67 | | - |
68 | | -- [Sign up](https://portal.aws.amazon.com/billing/signup#/start) and login to your AWS account |
69 | | - |
70 | | -- Add `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` to [your GitHub repo's secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets). Go to your AWS [security credentials](https://console.aws.amazon.com/iam/home?region=us-west-2#/security_credentials) and click on the "Access keys" tab, and then click "Create New Access Key", then you can copy those and add them to your repo's secrets. |
71 | | - |
72 | | -- Install the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html#getting-started-install-instructions). |
73 | | - |
74 | | -- Create an [AWS credentials file](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-quickstart.html#getting-started-quickstart-new). |
75 | | - |
76 | | -- Along with your AWS credentials, you'll also need to give your CloudFormation a `SESSION_SECRET` variable of its own for both staging and production environments, as well as an `ARC_APP_SECRET` for Arc itself. |
77 | | - |
78 | | - ```sh |
79 | | - npx arc env --add --env staging ARC_APP_SECRET $(openssl rand -hex 32) |
80 | | - npx arc env --add --env staging SESSION_SECRET $(openssl rand -hex 32) |
81 | | - npx arc env --add --env production ARC_APP_SECRET $(openssl rand -hex 32) |
82 | | - npx arc env --add --env production SESSION_SECRET $(openssl rand -hex 32) |
83 | | - ``` |
84 | | - |
85 | | - If you don't have openssl installed, you can also use [1password](https://1password.com/password-generator) to generate a random secret, just replace `$(openssl rand -hex 32)` with the generated secret. |
86 | | - |
87 | | -## Where do I find my CloudFormation? |
88 | | - |
89 | | -You can find the CloudFormation template that Architect generated for you in the sam.yaml file. |
90 | | - |
91 | | -To find it on AWS, you can search for [CloudFormation](https://console.aws.amazon.com/cloudformation/home) (make sure you're looking at the correct region!) and find the name of your stack (the name is a PascalCased version of what you have in `app.arc`, so by default it's MyRemixAppC4a6Staging and MyRemixAppC4a6Production) that matches what's in `app.arc`, you can find all of your app's resources under the "Resources" tab. |
92 | | - |
93 | | -## GitHub Actions |
94 | | - |
95 | | -We use GitHub Actions for continuous integration and deployment. Anything that gets into the `main` branch will be deployed to production after running tests/build/etc. Anything in the `dev` branch will be deployed to staging. |
96 | | - |
97 | | -## Testing |
98 | | - |
99 | | -### Cypress |
100 | | - |
101 | | -We use Cypress for our End-to-End tests in this project. You'll find those in the `cypress` directory. As you make changes, add to an existing file or create a new file in the `cypress/e2e` directory to test your changes. |
102 | | - |
103 | | -We use [`@testing-library/cypress`](https://testing-library.com/cypress) for selecting elements on the page semantically. |
104 | | - |
105 | | -To run these tests in development, run `npm run test:e2e:dev` which will start the dev server for the app as well as the Cypress client. Make sure the database is running in docker as described above. |
106 | | - |
107 | | -We have a utility for testing authenticated features without having to go through the login flow: |
108 | | - |
109 | | -```ts |
110 | | -cy.login(); |
111 | | -// you are now logged in as a new user |
112 | | -``` |
113 | | - |
114 | | -### Vitest |
115 | | - |
116 | | -For lower level tests of utilities and individual components, we use `vitest`. We have DOM-specific assertion helpers via [`@testing-library/jest-dom`](https://testing-library.com/jest-dom). |
117 | | - |
118 | | -### Type Checking |
119 | | - |
120 | | -This project uses TypeScript. It's recommended to get TypeScript set up for your editor to get a really great in-editor experience with type checking and auto-complete. To run type checking across the whole project, run `npm run typecheck`. |
121 | | - |
122 | | -### Linting |
123 | | - |
124 | | -This project uses ESLint for linting. That is configured in `.eslintrc.js`. |
125 | | - |
126 | | -### Formatting |
127 | | - |
128 | | -We use [Prettier](https://prettier.io/) for auto-formatting in this project. It's recommended to install an editor plugin (like the [VSCode Prettier plugin](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)) to get auto-formatting on save. There's also a `npm run format` script you can run to format all files in the project. |
| 36 | +- **Interactive 3D Experiences**: Wanted to learn Three.js so built a 3D game |
| 37 | +- **Articles & Blog**: Rolled my own CMS based off Markdown |
| 38 | +- **Responsive Design**: Mobile-first approach with Tailwind CSS |
| 39 | +- **Analytics**: Google Analytics integration (GA4) |
| 40 | +- **SEO Optimized**: Server-side rendering with TanStack Start. Probably my favorite framework of a framework thus far. |
0 commit comments