Remix folk Stack

Learn more about Remix Stacks.

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

What's in the stack

Multi-region Fly app deployment with Docker
Multi-region Fly PostgreSQL Cluster
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
Database ORM with Prisma
Styling with Tailwind
End-to-end testing with Cypress
Local third party request mocking with MSW
Error monitoring with Sentry
Unit testing with Vitest and Testing Library
Code formatting with Prettier
Linting with ESLint
Static Types with TypeScript

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
```
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: [email protected]
Password: rachelrox

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.

creating users, and logging in and out ./app/models/user.server.ts
user sessions, and verifying them ./app/session.server.ts

Deployment

This Remix Stack comes with two CircleCi Pipeline 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
```

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

fly create folk-stack-template
fly create folk-stack-template-staging

Create a new GitHub Repository
Link the repo to a CircleCI organization
Set up CircleCI
- add a FLY_API_TOKEN to your CircleCI project. To do this, go to your user settings on Fly and create a new token, then add it to your project secrets with the name FLY_API_TOKEN.
- add a FLY_APP_NAME to your CircleCI project. The environmant variable to set is FLY_APP_NAME=folk-stack-template
Set Up Sentry
- Get yout app DSN Login into your Sentry account and go to your app Client Keys settings (create an app if not exists yet). To get to the Client Keys screen go to `Settings > Projects > [your project] > Client Keys. Copy your DSN
- Add a SENTRY_DSN and SENTRY_ENVIRONMENT to your fly app secrets, to do this you can run the following commands:
```
fly secrets set SENTRY_DSN=<YOUR_DSN> SENREY_ENVIRONMENT=production --app folk-stack-template
fly secrets set SENTRY_DSN=<YOUR_DSN> SENREY_ENVIRONMENT=staging --app folk-stack-template-staging
```
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 folk-stack-template
fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app folk-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 a database for both your staging and production environments. Run the following:

fly postgres create --name folk-stack-template-db
fly postgres attach --postgres-app folk-stack-template-db --app folk-stack-template

fly postgres create --name folk-stack-template-staging-db
fly postgres attach --postgres-app folk-stack-template-staging-db --app folk-stack-template-staging

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.

Circleci Pipeline

We use Circleci 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.

kokoapps / folk-stack Goto Github PK

folk-stack's Introduction