kantharia / starter-architect

Remix Starter for Architect (AWS CloudFormation with arc.codes)

Please Don't Use

Please use npm init remix instead of this starter repo to create a new Remix app. This repository was archived on April 29, 2021.

Remix Starter for Architect (AWS CloudFormation)

Welcome to Remix!

This is a starter repo for using Remix with Architect (wrapper around AWS CloudFormation).

Development

When developing your app, you'll need two terminal tabs, one to run Architect's sandbox, and the other to run the Remix development server. In production, however, the Remix development server won't be used because your assets will be built and shipped with the server.

First, .npmrc.example to .npmrc and insert the license key you get from logging in to your dashboard at remix.run.

Note: if this is a public repo, you'll probably want to move the line with your key into ~/.npmrc to keep it private.

Next, install all dependencies using npm:

npm install

Your @remix-run/* dependencies will come from the Remix package registry.

Remix Development Server

Once everything is installed, start the Remix asset server with the following command:

npm run dev

The dev server automatically rebuilds as your source files change.

Architect Sandbox

Architect recommends installing their CLI and the AWS sdk globally:

$ npm i -g @architect/architect aws-sdk

Now start the sandbox:

$ arc sandbox

You should now be able to visit http://localhost:3333.

Deploying

First, you'll need to have the AWS CLI installed, here are the instructions. Then follow the Architect setup instructions: https://arc.codes/docs/en/guides/get-started/detailed-aws-setup.

Now you're ready to deploy. From the Remix http handler directory, build the app for production:

$ npm run build

And then from the root of the project, deploy with arc.

$ arc deploy

That's it!

Documentation

Detailed documentation for Remix is available at remix.run.