The Epic Stack 🚀

A starter project for building Epic web applications

This is a Remix Stack with the foundational things setup and configured for you to hit the ground running on your next Epic idea.

---

Learn more about Remix Stacks.

npx create-remix@latest --template epicweb-dev/epic-stack

What's in the stack

• Fly app deployment with Docker
• Multi-region, distributed, production-ready SQLite Database with LiteFS.
• Healthcheck endpoint for Fly backups region fallbacks
• GitHub Actions for deploy on merge to production and staging environments
• Email/Password Authentication with cookie-based sessions with email sending via Mailgun and forgot password/password reset support.
• Database ORM with Prisma
• Styling with Tailwind
• End-to-end testing with Playwright
• 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
• Runtime schema validation with zod

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

• Initial setup:

  npm run setup

• Start dev server:

  npm run dev

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: kody@epicweb.dev
• Password: kodylovesyou

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

The Epic Stack comes with a GitHub Action that handles 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 apps create epic-stack-template
  fly apps create epic-stack-template-staging

  Note: Make sure this name matches the app set in your fly.toml file. Otherwise, you will not be able to deploy.

  • 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) ENCRYPTION_SECRET=$(openssl rand -hex 32) --app epic-stack-template
  fly secrets set SESSION_SECRET=$(openssl rand -hex 32) ENCRYPTION_SECRET=$(openssl rand -hex 32) --app epic-stack-template-staging

  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 an account on Mailgun, create a Sending API Key (find it at https://app.mailgun.com/app/sending/domains/YOUR_SENDING_DOMAIN/sending-keys replacing YOUR_SENDING_DOMAIN with your sending domain) and set MAILGUN_DOMAIN and MAILGUN_SENDING_KEY environment variables in both prod and staging:

  fly secrets set MAILGUN_DOMAIN="mg.example.com" MAILGUN_SENDING_KEY="some-api-token-with-dashes" --app epic-stack-template
  fly secrets set MAILGUN_DOMAIN="mg.example.com" MAILGUN_SENDING_KEY="some-api-token-with-dashes" --app epic-stack-template-staging

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

  fly volumes create data --size 1 --app epic-stack-template
  fly volumes create data --size 1 --app epic-stack-template-staging

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.

Connecting to your database

The sqlite database lives at /data/sqlite.db in the deployed application. You can connect to the live database by running fly ssh console -C database-cli.

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

Playwright

We use Playwright for our End-to-End tests in this project. You'll find those in the tests directory. As you make changes, add to an existing file or create a new file in the tests directory to test your changes.

To run these tests in development, run npm run test:e2e:dev which will start the dev server for the app and run Playwright on it.

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

test('my test', async ({ page, login }) => {
	const user = await login()
	// you are now logged in
})

We also auto-delete the user at the end of your test. 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.