Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/remix-run/starter-architect
Remix Starter for Architect (AWS CloudFormation with arc.codes)
https://github.com/remix-run/starter-architect
architect aws-cloudformation remix
Last synced: about 2 months ago
JSON representation
Remix Starter for Architect (AWS CloudFormation with arc.codes)
- Host: GitHub
- URL: https://github.com/remix-run/starter-architect
- Owner: remix-run
- Archived: true
- Created: 2020-12-11T17:46:31.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-04-29T23:48:19.000Z (over 3 years ago)
- Last Synced: 2024-05-09T08:33:09.639Z (4 months ago)
- Topics: architect, aws-cloudformation, remix
- Language: TypeScript
- Homepage:
- Size: 227 KB
- Stars: 24
- Watchers: 3
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-remix - Starter Architect - Archived. (Starter)
- awesome-remix - Starter Architect - Archived. (Starter)
README
## 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](https://remix.run) with [Architect](http://arc.codes) (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](https://remix.run/dashboard).
> 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`:
```sh
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:
```sh
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:
```sh
$ npm i -g @architect/architect aws-sdk
```
Now start the sandbox:
```sh
$ 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](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html). 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:
```sh
$ npm run build
```
And then from the root of the project, deploy with `arc`.
```sh
$ arc deploy
```
That's it!
## Documentation
Detailed documentation for Remix [is available at remix.run](https://docs.remix.run).