arroiz / remix-pop-punk-stack

The Remix Stack for deploying to Fly with SQLite, authentication, testing, linting, formatting, etc.

Home Page:https://remix.run/stacks

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Remix Pop Punk Stack

The Remix Pop Punk Stack

Learn more about Remix Stacks.

npx create-remix --template https://github.com/arroiz/remix-pop-punk-stack

What's in the stack

Not a fan of bits of the stack? Fork it, change it, and use npx create-remix --template your/repo! Make it your own.

Development

  • Initial setup: If you just generated this project, this step has been done for you.

    npm run setup
  • Setup the database

  • Validate the app has been set up properly (optional):

    npm run validate
  • 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: rachel@remix.run
  • Password: rachelrox

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.

Setup database

This project is configured to use PlanetScale. This is a mysql cloud database that has a good free plan.

To setup the database you will need to create a free account (no credit card required) and create a new database, after few seconds, when database be available you will just need to click in the button connect. In the modal that will show up, open the connect with selection and select prisma, then click in new password and copy the DATABASE_URL and paste in .env file.

Now run the command: npx prisma db push

TODO create a file for this proccess

Deployment

This Remix Stack comes with two GitHub Actions that handle automatically deploying your app to production and staging environments.

TODO

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 user

We 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.

About

The Remix Stack for deploying to Fly with SQLite, authentication, testing, linting, formatting, etc.

https://remix.run/stacks


Languages

Language:TypeScript 91.1%Language:JavaScript 6.1%Language:Dockerfile 2.0%Language:Shell 0.8%