KCD Quick Stack

The primary use of this stack is for Kent to quickly setup new Remix apps that have no more than the bare necessities.

Learn more about Remix Stacks.

npx create-remix --template kentcdodds/quick-stack

What's in the stack

Fly app deployment with Docker
Production-ready SQLite Database
GitHub Actions for deploy on merge to production
Email/Password Authentication with cookie-based sessions
Database ORM with Prisma
Styling with Tailwind
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

This step only applies if you've opted out of having the CLI install dependencies for you:
```
npx remix init
```
Initial setup: If you just generated this project, this step has been done for you.
```
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: rachel@remix.run
Password: racheliscool

Relevant code:

This app does nothing. You can login and logout. That's it.

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 GitHub Actions that handle automatically deploying your app to production.

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 production:
```
fly create school-records-5b34
```
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 command:
```
fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app school-records-5b34
```
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 persistent volume for the sqlite database for your production environment. Run the following:
```
fly volumes create data --size 1 --app school-records-5b34
```

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.

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. 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 the build (we do not run linting/typescript in CI... This is quick remember?).

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.

morrisonak / school-records