kaushalshah-98 / boilerplate-remix

Boilerplate Remix

Typescript + React + Remix + Prisma

Comes with user authentication included

• React
• Prisma
• Remix
• TypeScript
• Postgres
• Chakra UI
• Customizable theme & Dark mode
• Eslint
• Prettier
• Sendgrid SMTP
• Husky
• Lint staged

& many more tasty treats

Get Started

Must have node, yarn, postgres and redis installed and setup locally

1. yarn install
2. createdb boilerplate
3. yarn db:migrate

Make sure you have created a .env file in the api package with the right values, you can use .env.example as the template

We use Husky to run a couple of checks each commit (prettier, eslint & commitlint), make sure to add a .huskyrc file to your home directory ~/.huskyrc, and add this in:

export PATH="/usr/local/bin:$PATH"

then run

npx husky install

Development

yarn dev

Production

Mailers

• Create a Sendgrid account and set a SENDGRID_API_KEY environment variable in .env
• Create templates for each email you want to send and use the templateId in the corresponding mailer class

Deployment

An example is deployed here

We are using Vercel for deployment + Heroku for hosting the database

Extra info

• Remix Docs