Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 2.71 KB

README.md

File metadata and controls

71 lines (46 loc) · 2.71 KB

Synthwave Stack

Synthwave Stack

Learn more about Remix Stacks.

pnpm create remix@latest --template i4o-oss/synthwave-stack

What's in the box (well, 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

Install dependencies:

pnpm i

Start dev server:

pnpm dev

Note: Uses Remix App Server with HMR/HDR. Feel free to switch to a different server.

Documentation:

Coming Soon

Deployment

This Remix Stack handles automatically deploying your app to production and staging environments on Railway.

All you have to do is to create a project on Railway and choose your repo. Railway handles setting up CI/CD.

Connecting to your database

The database lives on planetscale.com. Prisma has been configured to connect to Planetscale and will work in local environment. Update the database name in DATABASE_URL variable in your .env for local development use. Use the connection string provided on Planetscale dashboard as DATABASE_URL in production.

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 pnpm 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 pnpm format script you can run to format all files in the project.