Click this button to create a Gitpod workspace with the project set up
-
Initial setup:
yarn setup
-
Start dev server:
yarn 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
We use Playwright for our End-to-End tests in this project. You'll find those in
the tests
directory. As you make changes, add to an existing file or create a
new one.
To run these tests in development, run yarn test:e2e:dev
which will start the
dev server for the app as well as the Playwright client. Make sure the database
is running.
For lower level tests of utilities and individual components, we use vitest
.
We have DOM-specific assertion helpers via
@testing-library/jest-dom
.
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
yarn typecheck
.
This project uses ESLint for linting. That is configured in .eslintrc.js
.
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 yarn format
script you can run
to format all files in the project.