Awesome
Welcome to Remix!
Setup?
Configure the database ft. Railway App(PostgreSQL)
- Install the Railway.app CLI by following the instructions at https://docs.railway.app/cli/installation
- Once installed, login to it
railway login
and initialize a new Railway projectrailway init
- Provide the following details
Starting Point: Empty Project ā Enter project name: project-name ā Environment: production
- Go to URL:
https://railway.app/project/[project-id]/setup and link your project through the CLI
railway link [project-id]` - Go to PostgreSQL plugin page, the
Connect
tab, and copy the Postgres Connection URL (to be used in the Prisma config section) - To interact with the service through CLI, the other commands you might use are
railway run <cmd>
(run commnds in the railway environments) orrailway up
(to deploy your app)
Use Data Proxy URLs
For running on the edge, you'd be required to use the Prisma Data Platform (Data Proxy URLs) to interact with your cloud DB instance(no local connections allowed). Get connection string of the form prisma://aws-us-east-1.prisma-data.com/?api_key=...
from the data platform, by connecting your cloud DB instance.
Setup Prisma
- Set the DATABASE_URL in the .env file to point to your existing database. If your database has no tables yet, read https://pris.ly/d/getting-started
- Set the provider of the datasource block in schema.prisma to match your database:
postgresql
(for us). There are other configs we're not using likemysql
,sqlite
,sqlserver
(Preview) ormongodb
(Preview). - Run
npx prisma db pull
to turn your database schema into a Prisma schema - Open the
.env
file and place the connecting string(Postgres Connection URL) againstDATABASE_URL
. Prisma is smart enough to use this by its special annotation in the/prisma/schema.prisma
fileenv("DATABASE_URL")
. Keeppostgresql
as the DB type - Run
npm run generate
to generate the Prisma Client (with Data Proxy enabled) . You can then start querying your database.
Misc Steps
- Migrate:
npm run migrate:dev
andnpm run migrate:deploy
- Seed:
npm run seed
- Reset -
npm run migrate:reset
All the above commands require the original connection string, so keep the connection string handy, and manually update them inschema.prisma
before running your local migrations. Once done, revert back to the original Data Proxy URLs to allow for Prisma client calls
Others
To open studio use npx prisma studio
Development
You will be running several processes during development:
- The Miniflare server (miniflare is a local environment for Cloudflare Workers)
- The Remix development server
- TailwindCSS server to watch and emit updated CSS files
# in one tab, start the remix dev server
$ npm run dev
If you'd like to change any aspects of this behavior, see how the commands are configured in your
package.json
file
Open up http://127.0.0.1:8787 and you should be ready to go!
Deployment
Use wrangler to build and deploy your application to Cloudflare Workers. If you don't have it yet, follow the installation guide to get it setup. Be sure to authenticate the CLI as well.
If you don't already have an account, then create a cloudflare account here and after verifying your email address with Cloudflare, go to your dashboard and set up your free custom Cloudflare Workers subdomain.
Once that's done, you should be able to deploy your app:
npm run deploy