Overview
The Remix Starter Kit is a boilerplate based on Remix, designed to provide developers with all the necessary tools and features to quickly start a Remix project with Supabase. It includes essential components, language choices, styling options, and additional functionalities such as authentication and user profiles.
Features
- Typescript: The project is set up with Typescript as the chosen language.
- Tailwind CSS: Tailwind CSS is included for easy and quick styling without leaving your HTML.
- Daisy UI: This kit also comes with pre-made TailwindCSS component classes from Daisy UI.
- Headless UI + React Hot Toast: Provides robust headless logic for components like Dialog/Modal, Dropdown, List, etc.
- WorkSans as the App font: WorkSans is the chosen font for the application.
- React-icons: Icons are available on-demand through React-icons, allowing for tree-shakeable icons.
- ESLint: The project includes ESLint for static code analysis.
- Prettier: Code formatting is handled by Prettier, including formatting for TailwindCSS classes.
- Playwright: Provides reliable end-to-end test cases, with specific test cases for the homepage and sign-in page.
- Supabase support: The kit includes integration with Supabase, offering an authentication system and user profiles.
- User Avatar with Supbase Storage: Images can be uploaded and stored on Supabase managed buckets, accessible through resource routes.
- Pre-made components: The kit includes a set of pre-made, easily replaceable components that are commonly used in non-trivial projects.
- Bonus: Additionally, the Remix Starter Kit provides options for integrating with Edge/Cloudflare and various databases like FaunaDB, Supabase, Prisma + DataProxy (Railway.app), or Prisma + DataProxy (Planetscale).
Installation
To install the Remix Starter Kit, follow these steps:
- Create a new project by clicking on “Use this template” above and create your own copy.
- Once you have your own copy, you can start working with it locally by running the following command:
This will install all the necessary dependencies for the project.
- Set up Supabase by creating an account and organization, as well as generating a Supabase project.
- Copy the generated project’s API authentication details from the Supabase dashboard and place them in the
.env file as SUPABASE_URL and SUPABASE_KEY. - Execute the provided queries in the Supabase editor to set up the profile table and storage for user avatars.
- When deploying the project, make sure to configure the
SUPABASE_URL and SUPABASE_KEY in your deployment service provider, such as Vercel.
For a full list of available commands and further instructions, refer to the package.json file in the project.
Summary
The Remix Starter Kit is a comprehensive boilerplate that combines Remix and Supabase to provide developers with a complete starting point for their projects. It includes all the essential features, language choices, and styling options, as well as additional functionalities like authentication and user profiles. The kit also offers pre-made components and options for integrating with different databases. By following the installation guide, developers can quickly set up the kit and start building their Remix project with Supabase.