Remix Indie Stack
Learn more about Remix Stacks.
npx create-remix@latest --template remix-run/indie-stackWhat's in the stack
- Fly app deployment with Docker
- Production-ready SQLite Database
- Healthcheck endpoint for Fly backups region fallbacks
- GitHub Actions for deploy on merge to production and staging environments
- Email/Password Authentication with cookie-based sessions
- Database ORM with Prisma
- Styling with Tailwind
- End-to-end testing with Cypress
- 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
Development
-
Initial setup:
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:
[email protected] - Password:
racheliscool
Relevant code:
This is a pretty simple note-taking app, but it's a good example of how you can build a full stack app with Prisma and Remix. The main functionality is creating users, logging in and out, and creating and deleting notes.
- creating users, and logging in and out ./app/models/user.server.ts
- user sessions, and verifying them ./app/session.server.ts
- creating, and deleting notes ./app/models/note.server.ts
Deployment
This Remix Stack comes with two GitHub Actions that handle automatically deploying your app to production and staging environments.
Prior to your first deployment, you'll need to do a few things:
-
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 whoamiand ensure the email matches the Fly account signed into the browser. -
Remove docker-related and Fly config file in order to use new Fly setups:
rm -f Dockerfile .dockerignore fly.toml
-
Initialize Fly apps. This will automatically recreate 3 files that we've just removed and also configure everything for Fly as recommended:
Until Remix complete the process of simplify and modernize deploy flow with Fly, we'll use this setup. Details of rethinking Remix/Indie stack & Fly deploy setup can be find in Indie stack's issue #252
fly launch
-
Give permission to run the
start.shscript on docker: In Dockerfile, change theENTRYPOINTline toRUN chmod +x "./start.sh" ENTRYPOINT [ "./start.sh" ] -
Deploy our apps to Fly:
fly 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_TOKENto 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 nameFLY_API_TOKEN.
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, and every commit to your dev branch will trigger a deployment to your staging environment.
Fly has a default value
auto_stop_machines = trueandauto_start_machines = true, so the apps can take around ~10s to restart. We'll keep it this way for cost-reduction.
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 tests/build/etc. Anything in the dev branch will be deployed to staging.
Testing
Cypress
We use Cypress for our End-to-End tests in this project. You'll find those in the cypress directory. As you make changes, add to an existing file or create a new file in the cypress/e2e directory to test your changes.
We use @testing-library/cypress for selecting elements on the page semantically.
To run these tests in development, run npm run test:e2e:dev which will start the dev server for the app as well as the Cypress client. Make sure the database is running in docker as described above.
We have a utility for testing authenticated features without having to go through the login flow:
cy.login();
// you are now logged in as a new userWe also have a utility to auto-delete the user at the end of your test. Just make sure to add this in each test file:
afterEach(() => {
cy.cleanupUser();
});That way, we can keep your local db clean and keep your tests isolated from one another.
Vitest
For lower level tests of utilities and individual components, we use vitest. We have DOM-specific assertion helpers via @testing-library/jest-dom.
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.
Import svg
This project uses React-SVGR to transform SVG Elements into React Elements, since React Elements are easier to use and type-safe.
Our conventions recommend adding SVG files to public/svgs and run
npm run svgReact components will be automatically created at app/components/svgs. There's a setup in SVGR's docs for Remix but we decided not to use it since it requires using a Prettier plugin, which can possibly conflict with other Prettier plugins.
Styling Guideline
Animation
Duration
- For short animation (small UI components):
duration-200
Transition
- Recommended (almost all the cases):
ease-out
Accessibility
- For keyboard-interaction input:
focus-visible:outline-[choose-your-color]
- For anything else (mouse/touchscreen):
focus:outline-[choose-your-color]
TODO List
- Feature: Tag system for Blogs
- Restructure design system & tailwind config
- Chore: Remove notes
- New page: All Links
- New page: Portfolio
- Feature: Blog Pagination
- Feature: Footer with contact
- New page: Reports and suggestions
- New page: Showcase
- New page: Landing page (replacement for current root page)
- Testing (cypress, vitest)
- Feature: Image hosting for Blog
- Feature: Mail collector - Subscription (Mailgun?)
- Feature: Sticky navbar ref
Coding Guideline
Conventions
Key for React Elements
`${componentName}-${itemId}`
For example, a Blog object in url blog will be rendered with the key:
`blog-${blog.id}`
Quality Assurance
User flows
Guest
- Sign up (join)
- Sign in
- See all blogs
- Read a blog
User
- All Guest's flows
- Sign out
Me
- All User's flows
- Post a blog
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent