Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nzambello/punk-stack
Remix stack with supabase, tailwind, jest, cypress and fly deploy and some opinionated tools.
https://github.com/nzambello/punk-stack
react remix remix-run remix-stack remix-stacks supabase supabase-auth
Last synced: 3 months ago
JSON representation
Remix stack with supabase, tailwind, jest, cypress and fly deploy and some opinionated tools.
- Host: GitHub
- URL: https://github.com/nzambello/punk-stack
- Owner: nzambello
- Created: 2022-04-09T12:21:36.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-09-10T10:49:35.000Z (about 2 years ago)
- Last Synced: 2024-05-09T08:31:22.985Z (6 months ago)
- Topics: react, remix, remix-run, remix-stack, remix-stacks, supabase, supabase-auth
- Language: TypeScript
- Homepage:
- Size: 250 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-remix - Remix Punk Stack
- awesome-remix - Remix Punk Stack
README
# Remix Punk Stack
[Remix](https://remix.run/stacks) stack with supabase, tailwind, jest, cypress and fly deploy and some opinionated tools.
Derived from [The Remix Blues Stack](https://github.com/remix-run/blues-stack) by @remix-run. Ref commit [7cdd098](https://github.com/remix-run/blues-stack/commit/7cdd0985b4c96b7c14ef234a3ee53fbf028c8f47).
Learn more about [Remix Stacks](https://remix.run/stacks).
```
npx create-remix --template nzambello/punk-stack
```
## What's in the stack
- [Multi-region Fly app deployment](https://fly.io/docs/reference/scaling/) with [Docker](https://www.docker.com/)
- Healthcheck endpoint for [Fly backups region fallbacks](https://fly.io/docs/reference/configuration/#services-http_checks)
- [Supabase Database integration](https://supabase.com/)
- Email/Password Authentication with [Supabase Auth](https://supabase.com/docs/auth/)
- [GitHub Actions](https://github.com/features/actions) for deploy on merge to production and staging environments
- Styling with [Tailwind](https://tailwindcss.com/)
- End-to-end testing with [Cypress](https://cypress.io)
- Local third party request mocking with [MSW](https://mswjs.io)
- Unit testing with [Vitest](https://vitest.dev) and [Testing Library](https://testing-library.com)
- Code formatting with [Prettier](https://prettier.io)
- Linting with [ESLint](https://eslint.org)
- Static Types with [TypeScript](https://typescriptlang.org)
- Husky pre-commit hooks running tests and linting
- [Commmitlint](https://commitlint.js.org/) for commit message validation based on [Conventional Commits](https://www.conventionalcommits.org/en/)
- Changelog and release management with [release-it](https://github.com/release-it/release-it), using convential changellog
Not a fan of bits of the stack? Fork it, change it, and use `npx create-remix --template your/repo`! Make it your own.
## Setup and development
- Install dependencies
```sh
yarn
# or npm install
# or pnpm install
```
- Create a supabase project on [app.supabase.io](https://app.supabase.io)
- Create a new supabase database (refer to the [supabase docs](https://supabase.com/docs/getting-started) for more information). Follow types definition for table structures.
- Setup supabase environment variables in `.env`, example:
```env
SUPABASE_ANON_KEY=
SUPABASE_API_URL=
SESSION_SECRET="super-duper-s3cret"
# supabase user to use for authentication in e2e tests
# signup once in the browser to create your test user
# DISCLAIMER: didn't find a better way, please don't use this in production
# see https://github.com/supabase/supabase/discussions/6177
SUPABASE_E2ETEST_USERMAIL="[email protected]"
SUPABASE_E2ETEST_PASSWORD="your-supabase-user-password"
```
- Start dev server:
```sh
npm run dev
```
This starts your app in development mode, rebuilding assets on file changes.
### 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.
- creating users, and logging in and out [./app/models/user.server.ts](./app/models/user.server.ts)
- user sessions, and verifying them [./app/session.server.ts](./app/session.server.ts)
- creating, and deleting notes [./app/models/note.server.ts](./app/models/note.server.ts)
## Update types from supabase
```sh
npx openapi-typescript https://your-project-id.supabase.co/rest/v1/?apikey=your-anon-key --output types/supabase.ts
```
## 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](https://fly.io/docs/getting-started/installing-flyctl/)
- Sign up and log in to Fly
```sh
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:
```sh
fly create maileditor-app-13b9
fly create maileditor-app-13b9-staging
```
- Initialize Git.
```sh
git init
```
- Create a new [GitHub Repository](https://repo.new), and then add it as the remote for your project. **Do not push your app yet!**
```sh
git remote add origin
```
- Add a `FLY_API_TOKEN` to your GitHub repo. To do this, go to your user settings on Fly and create a new [token](https://web.fly.io/user/personal_access_tokens/new), then add it to [your repo secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) with the name `FLY_API_TOKEN`.
- Setup supabase environment variables in `.env`, example:
```env
SUPABASE_ANON_KEY=
SUPABASE_API_URL=
SESSION_SECRET="super-duper-s3cret"
```
- Add a `SESSION_SECRET` to your fly app secrets, to do this you can run the following commands:
```sh
fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app maileditor-app-13b9
fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app maileditor-app-13b9-staging
```
> **Note:** When creating the staging secret, you may get a warning from the Fly CLI that looks like this:
>
> ```
> WARN app flag 'maileditor-app-13b9-staging' does not match app name in config file 'maileditor-app-13b9'
> ```
>
> 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](https://1password.com/generate-password) 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:
```sh
fly postgres create --name maileditor-app-13b9-db
fly postgres attach --postgres-app maileditor-app-13b9-db --app maileditor-app-13b9
fly postgres create --name maileditor-app-13b9-staging-db
fly postgres attach --postgres-app maileditor-app-13b9-staging-db --app maileditor-app-13b9-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.
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](https://community.fly.io). 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](https://fly.io/docs/reference/scaling/) and [Multi-region PostgreSQL](https://fly.io/docs/getting-started/multi-region-databases/) 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](https://modheader.com/) 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`](https://testing-library.com/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:
```ts
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:
```ts
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`](https://testing-library.com/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](https://prettier.io/) for auto-formatting in this project. It's recommended to install an editor plugin (like the [VSCode Prettier plugin](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)) to get auto-formatting on save. There's also a `npm run format` script you can run to format all files in the project.