Remix Purple Stack

Learn more about Remix Stacks.

npx create-remix@latest --template kevin-mind/remix-run-purple-stack

What's in the stack

• GitHub Actions for deploy on merge to production and staging environments
• Auth0 Authentication for authenticating users
• Database ORM with Prisma
• Styling with Tailwind
• Local third party request mocking with MSW
• Unit testing with Vitest and Testing Library
• Code formatting with Prettier
• Linting with ESLint
• Static Types with TypeScript

Quickstart

Click this link to create a Gitpod workspace with the project set up

Development

• This step only applies if you've opted out of having the CLI install dependencies for you:

  npx remix init

• Start the Postgres Database in Docker:

  npm run docker

  Note: The npm script will complete while Docker sets up the container in the background. Ensure that Docker has finished and your container is running before proceeding.

• Initial setup:

  npm run script setup

• Run the first build:

  npm run build

• Start dev server:

  npm run dev

This starts your app in development mode, rebuilding assets on file changes.

Setup deployment and authorization

To configure auth0 in development, use the setup script to authenticate and setup your environment variables.

npm run script setup

Relevant code:

Deployment

This Remix Stack comes with two GitHub Actions that handle automatically deploying your app to production and staging environments.

GitHub Actions

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.

Testing

Vitest

For lower level tests of utilities and individual components, we use vitest. We have DOM-specific assertion helpers via @testing-library/jest-dom.

Type Checking

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.

Linting

This project uses ESLint for linting. That is configured in .eslintrc.js.

Formatting

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.