The public repository for the RemixAustin.com website.
(Based on the Remix Indie Stack, but with all the default content & Prisma/SQLite stuff removed).
Well that might be slightly premature ... this site is in its infancy and we're not quite ready for contributions beyond our core team 😐 Check back soon for how to contribute!
You can, however, create an issue to alert of us about any bugs or desired features!
- Fly app deployment with Docker
- Healthcheck endpoint for Fly backups region fallbacks
- GitHub Actions for deploy on merge to production and staging environments
- Styling with Tailwind
- Local third party request mocking with MSW
- Unit testing with Vitest and Testing Library
- Code formatting with Prettier
- Linting with ESLint
- Static Types with TypeScript
-
Use nvm to use the minimum Node.js version (
18.3.0):nvm use
-
Install dependencies:
npm i
-
Start dev server:
npm run dev
This starts your app in development mode, rebuilding assets on file changes.
(to-do)
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 npm run ts.
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 npm run format script you can run to format all files in the project.
Check out our deployment docs.
Remix Austin has adopted the MIT license for the remixaustin.com website.