-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
19 additions
and
192 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,203 +1,30 @@ | ||
| # Remix Blues Stack | ||
| # linkdrop | ||
|
|
||
|  | ||
|  | ||
|
|
||
| Learn more about [Remix Stacks](https://remix.run/stacks). | ||
| linkdrop is a web app that saves links so you can search for them later. | ||
|
|
||
| ``` | ||
| npx create-remix --template remix-run/blues-stack | ||
| ``` | ||
|
|
||
| ## What's in the stack | ||
|
|
||
| - [Multi-region Fly app deployment](https://fly.io/docs/reference/scaling/) with [Docker](https://www.docker.com/) | ||
| - [Multi-region Fly PostgreSQL Cluster](https://fly.io/docs/getting-started/multi-region-databases/) | ||
| - Healthcheck endpoint for [Fly backups region fallbacks](https://fly.io/docs/reference/configuration/#services-http_checks) | ||
| - [GitHub Actions](https://github.com/features/actions) for deploy on merge to production and staging environments | ||
| - Email/Password Authentication with [cookie-based sessions](https://remix.run/docs/en/v1/api/remix#createcookiesessionstorage) | ||
| - Database ORM with [Prisma](https://prisma.io) | ||
| - 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) | ||
|
|
||
| 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](https://www.docker.com/get-started): | ||
|
|
||
| ```sh | ||
| 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: | ||
|
|
||
| ```sh | ||
| npm run setup | ||
| ``` | ||
|
|
||
| - Run the first build: | ||
|
|
||
| ```sh | ||
| npm run build | ||
| ``` | ||
|
|
||
| - Start dev server: | ||
|
|
||
| ```sh | ||
| 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: `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](https://fly.io/docs/reference/private-networking/#install-your-wireguard-app), and the instructions for creating a development database [here](https://fly.io/docs/reference/postgres/). | ||
|
|
||
| ### 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) | ||
| ## 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 linkdrop-d071 | ||
| fly create linkdrop-d071-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!** | ||
| ## Features | ||
|
|
||
| ```sh | ||
| git remote add origin <ORIGIN_URL> | ||
| ``` | ||
| - Saving links with tags | ||
| - Searching for links with tags | ||
| - It's a small feature set, but I think it does it well. | ||
|
|
||
| - 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`. | ||
| ## History | ||
|
|
||
| - Add a `SESSION_SECRET` to your fly app secrets, to do this you can run the following commands: | ||
| This is a reimagination of a previous project, called [the-index](https://github.com/s-thom/the-index). I stopped working on that project because hosting data is hard, and writing new code is fun. Maybe that's why I have so many almost-finished projects lying around... | ||
|
|
||
| ```sh | ||
| fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app linkdrop-d071 | ||
| fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app linkdrop-d071-staging | ||
| ``` | ||
| Anyway, this was a good opportunity to experiment with the framework-du-jour, and see what tradeoffs it makes. Now I just need to remember to use it to save links. | ||
|
|
||
| > **Note:** When creating the staging secret, you may get a warning from the Fly CLI that looks like this: | ||
| > | ||
| > ``` | ||
| > WARN app flag 'linkdrop-d071-staging' does not match app name in config file 'linkdrop-d071' | ||
| > ``` | ||
| > | ||
| > 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 linkdrop-d071-db | ||
| fly postgres attach --postgres-app linkdrop-d071-db --app linkdrop-d071 | ||
| fly postgres create --name linkdrop-d071-staging-db | ||
| fly postgres attach --postgres-app linkdrop-d071-staging-db --app linkdrop-d071-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 | ||
| ``` | ||
| ## Development | ||
|
|
||
| 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: | ||
| This project is based on the [Remix Blues stack](https://github.com/remix-run/blues-stack). The README of that project is the best starting place for information. | ||
|
|
||
| ```ts | ||
| afterEach(() => { | ||
| cy.cleanupUser(); | ||
| }); | ||
| ```sh | ||
| npm ci | ||
| npm run docker | ||
| npm run setup | ||
| npm run build | ||
| # and finally | ||
| npm run dev | ||
| ``` | ||
|
|
||
| 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. |