Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chiangs/nordic-folk
Fork of the Remix Indie Stack for deploying to Fly with SQLite, authentication, testing, linting, formatting, etc. Without Tailwind; still a work in progress!!!
https://github.com/chiangs/nordic-folk
remix-stack
Last synced: about 2 months ago
JSON representation
Fork of the Remix Indie Stack for deploying to Fly with SQLite, authentication, testing, linting, formatting, etc. Without Tailwind; still a work in progress!!!
- Host: GitHub
- URL: https://github.com/chiangs/nordic-folk
- Owner: chiangs
- Fork: true (remix-run/indie-stack)
- Created: 2022-04-28T20:39:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-04-30T07:47:51.000Z (over 2 years ago)
- Last Synced: 2024-05-09T08:31:21.526Z (5 months ago)
- Topics: remix-stack
- Language: TypeScript
- Homepage:
- Size: 1.6 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-remix - Remix Nordic Folk Stack
- awesome-remix - Remix Nordic Folk Stack
README
# Remix Nordic Folk Stack
Learn more about [Remix Stacks](https://remix.run/stacks).
```
npx create-remix --template chiangs/nordic-folk
```
## Table of Contents
- [Remix Nordic Folk Stack](#remix-nordic-folk-stack)
- [Table of Contents](#table-of-contents)
- [What's in the stack](#whats-in-the-stack)
- [Development](#development)
- [Relevant code:](#relevant-code)
- [Deployment](#deployment)
- [Connecting to your database](#connecting-to-your-database)
- [Getting Help with Deployment](#getting-help-with-deployment)
- [GitHub Actions](#github-actions)
- [Testing](#testing)
- [Cypress](#cypress)
- [Vitest](#vitest)
- [Type Checking](#type-checking)
- [Linting](#linting)
- [Formatting](#formatting)
- [Google Analytics](#google-analytics)
- [Metronome](#metronome)
## What's in the stack
- [Fly app deployment](https://fly.io) with [Docker](https://www.docker.com/)
- 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
- Production-ready [SQLite Database](https://sqlite.org)
- Database ORM with [Prisma](https://prisma.io)
- Email/Password Authentication with [cookie-based sessions](https://remix.run/docs/en/v1/api/remix#createcookiesessionstorage)
- Local third party request mocking with [MSW](https://mswjs.io)
- End-to-end testing with [Cypress](https://cypress.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)
- ~~Styling with [Tailwind](https://tailwindcss.com/)~~
- Web Core Vitals monitoring with [Metronome](https://metronome.sh)
- Google Analytics 4
- Path aliases using [alias-hq](https://github.com/davestewart/alias-hq)
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: _If you just generated this project, this step has been done for you._
```sh
npm run setup
```
- 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`
### 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 indie-stack-template
fly create indie-stack-template-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`.
- 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 indie-stack-template
fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app indie-stack-template-staging
```
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 persistent volume for the sqlite database for both your staging and production environments. Run the following:
```sh
fly volumes create data --size 1 --app indie-stack-template
fly volumes create data --size 1 --app indie-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 your deployed application. You can connect to the live database by running `fly ssh console -C database-cli`.
### Getting Help with Deployment
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.
## 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.
### Google Analytics
The `gtag` util file includes methods to import for page views and other events.
The `root.tsx` loads the main script and the tracker Id is provided as an environment variable via the loader.
It also has an effect after page loads to start tracking page view events.
Don't forget to create the environment variable with the tracker ID: `GA_TRACKING_ID`.
### Metronome
Add the following to `postinstall` script to `the package.json`
```json
{
"postinstall": "remix setup && metronome setup"
}
```
Run the setup command
```shell
npx metronome setup
```
Add the `postbuild` command
```json
{
"build": "remix build && metronome postbuild"
}
```
Don't forget to add your api key to `METRONOME_API_KEY` environment variable