No description
Find a file
2022-04-02 13:45:06 -04:00
.github/workflows switch to remix 2022-03-22 13:42:07 -04:00
app help me 2022-04-02 13:45:06 -04:00
cypress switch to remix 2022-03-22 13:42:07 -04:00
mocks switch to remix 2022-03-22 13:42:07 -04:00
other switch to remix 2022-03-22 13:42:07 -04:00
prisma help me 2022-04-02 13:45:06 -04:00
public help me 2022-04-02 13:45:06 -04:00
styles help me 2022-04-02 13:45:06 -04:00
test switch to remix 2022-03-22 13:42:07 -04:00
.dockerignore switch to remix 2022-03-22 13:42:07 -04:00
.eslintrc.js switch to remix 2022-03-22 13:42:07 -04:00
.gitignore switch to remix 2022-03-22 13:42:07 -04:00
.prettierignore switch to remix 2022-03-22 13:42:07 -04:00
cypress.json switch to remix 2022-03-22 13:42:07 -04:00
docker-compose.yml switch to remix 2022-03-22 13:42:07 -04:00
Dockerfile switch to remix 2022-03-22 13:42:07 -04:00
fly.toml switch to remix 2022-03-22 13:42:07 -04:00
package-lock.json switch to remix 2022-03-22 13:42:07 -04:00
package.json help me 2022-04-02 13:45:06 -04:00
pnpm-lock.yaml help me 2022-04-02 13:45:06 -04:00
README.md switch to remix 2022-03-22 13:42:07 -04:00
remix.config.js switch to remix 2022-03-22 13:42:07 -04:00
remix.env.d.ts switch to remix 2022-03-22 13:42:07 -04:00
server.ts switch to remix 2022-03-22 13:42:07 -04:00
tailwind.config.js switch to remix 2022-03-22 13:42:07 -04:00
tsconfig.json switch to remix 2022-03-22 13:42:07 -04:00
vitest.config.ts switch to remix 2022-03-22 13:42:07 -04:00

Remix Blues Stack

The Remix Blues Stack

Learn more about Remix Stacks.

npx create-remix --template remix-run/blues-stack

What's in the stack

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

Development

  • 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 setup
    
  • Start dev server:

    npm run dev
    

    Note: You may see a nasty error in the PM2 logs when you initially run the dev script. This should only appear once and will not affect your local app server. We are working on improving this!

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

The database seed script creates a new user with some data you can use to get started:

  • Email: rachel@remix.run
  • Password: racheliscool

If you'd prefer not to use Docker, you can also use Fly's Wireguard VPN to connect to a development database (or even your production database). You can find the instructions to set up Wireguard here, and the instructions for creating a development database here.

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 Prisma and Remix. The main functionality is creating users, logging in and out, and creating and deleting notes.

Deployment

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:

  • Install Fly

  • Sign up and log in to Fly

    fly auth signup
    

    Note: If you have more than one Fly account, ensure that you are signed into the same account in the Fly CLI as you are in the browser. In your terminal, run fly auth whoami and ensure the email matches the Fly account signed into the browser.

  • Create two apps on Fly, one for staging and one for production:

    fly create border-server-a1df
    fly create border-server-a1df-staging
    
  • Initialize Git.

    git init
    
  • Create a new GitHub Repository, and then add it as the remote for your project. Do not push your app yet!

    git remote add origin <ORIGIN_URL>
    
  • Add a FLY_API_TOKEN to your GitHub repo. To do this, go to your user settings on Fly and create a new token, then add it to your repo secrets with the name FLY_API_TOKEN.

  • Add a SESSION_SECRET to your fly app secrets, to do this you can run the following commands:

    fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app border-server-a1df
    fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app border-server-a1df-staging
    

    Note: When creating the staging secret, you may get a warning from the Fly CLI that looks like this:

    WARN app flag 'border-server-a1df-staging' does not match app name in config file 'border-server-a1df'
    

    This simply means that the current directory contains a config that references the production app we created in the first step. Ignore this warning and proceed to create the secret.

    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.

  • Create a database for both your staging and production environments. Run the following:

    fly postgres create --name border-server-a1df-db
    fly postgres attach --postgres-app border-server-a1df-db --app border-server-a1df
    
    fly postgres create --name border-server-a1df-staging-db
    fly postgres attach --postgres-app border-server-a1df-staging-db --app border-server-a1df-staging
    

    Note: You'll get the same warning for the same reason when attaching the staging database that you did in the fly set secret step above. No worries. Proceed!

Fly will take care of setting the DATABASE_URL secret for you.

Now that every 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.

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.