Home

Awesome

Remix Prog Stack

banner

npx create-remix --template k1sul1/prog-stack

psst, if you open this README after running the command above, you get commands that you can just copy-paste! Just get a markdown preview plugin for your editor and you're good to go!

Motivation behind the stack

I like Hasura more than I like Prisma. There, I said it. While Remix has killed almost every client side api call, I like having a GraphQL API and the option to talk to it from the browser. And everything else that Hasura offers, including... migrations that work. Dysfunctional migrations are what drove me away from Prisma.

This stack does not talk to Hasura from the browser, but you could make it do that if you wanted to, pretty easily.

One of the differences between Prisma & Hasura, other than the fact that comparing them is a total apples & oranges comparison, is that there is no schema file that you maintain manually with Hasura. With Hasura, you manage the db schema through hasura console, and write something like this:

export type User = {
  uuid: string;
  fname: string;
  lname: string;
  email: string;
  role: number;
  status: number;
  meta: JSON | null;
};

export async function getUserByEmail(email: User["email"]) {
  const { users } = await gqlReq<{ users: User[] }>(
    gql`
      query getUserByEmail($email: String) {
        users(where: { email: { _eq: $email } }) {
          uuid
          fname
          lname
          email
          role
          status
          meta
        }
      }
    `,
    { email }
  );

  if (!users.length) {
    return null;
  }

  return users[0];
}

What's in the stack

Almost everything that the Blues stack had when this stack was forked from it on 2022-06-17, and a tad more. You know if the repository has been kept up to date with the upstream, if this repository is ahead of blues-stack. Changes to blues are usually pretty minor so you can just manually copypaste them if I haven't had the time of synchronizing.

Not a fan of bits of the stack? Fork it, change it, and use npx create-remix --template your/repo! Make it your own.

What's missing from Blues?

How about that other stuff that you added?

Development

If you'd prefer not to use Docker locally, you can just point the local application to the Hasura instance you will deploy a bit later.

You should really at least glance at ./hasura/README.md before proceeding.

And take a look at the config file you're going to be running, just for your own sake. If you're running Linux, you have to make a few minor changes, that I've already made for you. Just add and remove some # characters from the docker-compose.yml.

cd hasura
docker compose up # it's going to take a while to get started.
# Open another terminal so you can see if something goes wrong
# WAIT for db and hasura to be up before proceeding
hasura seed # To populate the database
hasura console # To open up the console / db client.

You can also talk to the production instance with hasura console using --endpoint.

Note: Ensure that Docker has finished and your container is running before proceeding.

Additional note: This stack is setup a bit differently than Blues. Remix is one Fly application, Hasura is another. The database is attached to Hasura. If you wanted to, you could connect to the database from Remix, but then you'd be better of using Prisma in the first place.

This starts your app in development mode, rebuilding assets on file changes. Open it, and try creating an account, or logging in with rachel@remix.run using the password racheliscool.

If that doesn't work and you see something like An unexpected error occurred: webhook authentication request failed instead, ensure that you've configured docker correctly. I might accidentally change the default config options to Linux when working on the repo (did that twice already), as I work on Linux.

Relevant code:

This is a pretty simple note-taking app, but it's a good example of how you can build a full stack app with Hasura and Remix. The main functionality is creating users, logging in and out, and creating and deleting notes.

In addition to that, foundations for row level permissions have been laid. Users that hold the role UserRole.user can only view and delete their own notes, but administrators can see and delete others notes. You can manage the permissions from hasura console or through the configuration files.

hasura console permission editor

Deployment

If you don't care about GH actions, you can just run fly deploy in this and hasura directory to deploy your project after the initial setup. Even if you don't use GH actions, the information still applies to you.

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

Prior to your first deployment, you'll need to do a few things:

Now that everything is set up you can commit and push your changes to your repo. Every commit to your main branch will trigger a deployment to your production environment, and every commit to your dev branch will trigger a deployment to your staging environment.

If you run into any issues deploying to Fly, make sure you've followed all of the steps above and if you have, then post as many details about your deployment (including your app name) to the Fly support community. They're normally pretty responsive over there and hopefully can help resolve any of your deployment issues and questions.

Multi-region deploys

Once you have your site and database running in a single region, you can add more regions by following Fly's Scaling and Multi-region PostgreSQL docs.

Make certain to set a PRIMARY_REGION environment variable for your app. You can use [env] config in the fly.toml to set that to the region you want to use as the primary region for both your app and database.

Testing your app in other regions

Install the ModHeader browser extension (or something similar) and use it to load your app with the header fly-prefer-region set to the region name you would like to test.

You can check the x-fly-region header on the response to know which region your request was handled by.

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

Cypress

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.

We use @testing-library/cypress for selecting elements on the page semantically.

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.

We have a utility for testing authenticated features without having to go through the login flow:

cy.login();
// you are now logged in as a new user

We also have a utility to auto-delete the user at the end of your test. Just make sure to add this in each test file:

afterEach(() => {
  cy.cleanupUser();
});

That way, we can keep your local db clean and keep your tests isolated from one another.

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.