This is a app for tracking split times for different events. It's built with Remix and Architect. It's deployed to AWS using GitHub Actions.
-
Validate the app has been set up properly (optional):
npm run validate
-
Start dev server:
npm run dev
This starts your app in development mode, rebuilding assets on file changes.
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
Prior to your first deployment, you'll need to do a few things:
-
Create a new GitHub repo
-
Sign up and login to your AWS account
-
Add
AWS_ACCESS_KEY_ID
andAWS_SECRET_ACCESS_KEY
to your GitHub repo's secrets. Go to your AWS 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. -
Install the AWS CLI.
-
Create an AWS credentials file.
-
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 anARC_APP_SECRET
for Arc itself.npx arc env --add --env staging ARC_APP_SECRET $(openssl rand -hex 32) npx arc env --add --env staging SESSION_SECRET $(openssl rand -hex 32) npx arc env --add --env production ARC_APP_SECRET $(openssl rand -hex 32) npx arc env --add --env production SESSION_SECRET $(openssl rand -hex 32)
If you don't have openssl installed, you can also use 1password to generate a random secret, just replace
$(openssl rand -hex 32)
with the generated secret.
You can find the CloudFormation template that Architect generated for you in the sam.yaml file.
To find it on AWS, you can search for CloudFormation (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 SplitTimesA104Staging and SplitTimesA104Production) that matches what's in app.arc
, you can find all of your app's resources under the "Resources" tab.
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.
For lower level tests of utilities and individual components, we use vitest
. We have DOM-specific assertion helpers via @testing-library/jest-dom
.
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
.
This project uses ESLint for linting. That is configured in .eslintrc.js
.
We use Prettier for auto-formatting in this project. It's recommended to install an editor plugin (like the VSCode Prettier plugin) to get auto-formatting on save. There's also a npm run format
script you can run to format all files in the project.