Skip to content

Commit

Permalink
chore(templates/arc): update rec to install arc locally
Browse files Browse the repository at this point in the history
readme changes taken from #2213 as I can't push to that branch

Signed-off-by: Logan McAnsh <logan@mcan.sh>
  • Loading branch information
mcansh committed Mar 30, 2022
1 parent 0523d32 commit b0205ce
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 56 deletions.
34 changes: 7 additions & 27 deletions templates/arc-ts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,17 @@

- [Remix Docs](https://remix.run/docs)

## Architect Setup

When deploying to AWS Lambda with Architect, you'll need:

- Architect (`arc`) CLI
- AWS SDK

Architect recommends installing these globally:

```sh
npm i -g @architect/architect aws-sdk
```

## Development

You will be running two processes during development when using Architect as your server.
Both Remix and Architect have their own local servers, each of which is responsible for unique tasks related to local development.

- Your Architect server sandbox in one
- The Remix development server in another
To start both alongside one another, run:

```sh
# in one tab
arc sandbox

# in another
npm run dev
$ npm run dev
```

Open up [http://localhost:3333](http://localhost:3333) and you should be ready to go!

If you'd rather run everything in a single tab, you can look at [concurrently](https://npm.im/concurrently) or similar tools to run both processes in one tab.
Open up [http://localhost:3333](http://localhost:3333), and you should be ready to go!

## Deploying

Expand All @@ -41,9 +21,9 @@ Before you can deploy, you'll need to do some setup with AWS:
- First [install the AWS CLI](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).

If you make it through all of that, you're ready to deploy!
Once you make it through all of that, you're ready to deploy!

1. build the app for production:
1. Build the app for production:

```sh
npm run build
Expand All @@ -52,7 +32,7 @@ If you make it through all of that, you're ready to deploy!
2. Deploy with `arc`

```sh
arc deploy production
npx arc deploy production
```

You're in business!
1 change: 0 additions & 1 deletion templates/arc-ts/app.arc
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,3 @@ remix-architect-app
# @aws
# profile default
# region us-west-1

1 change: 1 addition & 0 deletions templates/arc-ts/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
"remix": "*"
},
"devDependencies": {
"@architect/architect": "^10.0.5",
"@remix-run/dev": "*",
"@remix-run/eslint-config": "*",
"@types/react": "^17.0.24",
Expand Down
34 changes: 7 additions & 27 deletions templates/arc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,17 @@

- [Remix Docs](https://remix.run/docs)

## Architect Setup

When deploying to AWS Lambda with Architect, you'll need:

- Architect (`arc`) CLI
- AWS SDK

Architect recommends installing these globally:

```sh
npm i -g @architect/architect aws-sdk
```

## Development

You will be running two processes during development when using Architect as your server.
Both Remix and Architect have their own local servers, each of which is responsible for unique tasks related to local development.

- Your Architect server sandbox in one
- The Remix development server in another
To start both alongside one another, run:

```sh
# in one tab
arc sandbox

# in another
npm run dev
$ npm run dev
```

Open up [http://localhost:3333](http://localhost:3333) and you should be ready to go!

If you'd rather run everything in a single tab, you can look at [concurrently](https://npm.im/concurrently) or similar tools to run both processes in one tab.
Open up [http://localhost:3333](http://localhost:3333), and you should be ready to go!

## Deploying

Expand All @@ -41,9 +21,9 @@ Before you can deploy, you'll need to do some setup with AWS:
- First [install the AWS CLI](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).

If you make it through all of that, you're ready to deploy!
Once you make it through all of that, you're ready to deploy!

1. build the app for production:
1. Build the app for production:

```sh
npm run build
Expand All @@ -52,7 +32,7 @@ If you make it through all of that, you're ready to deploy!
2. Deploy with `arc`

```sh
arc deploy production
npx arc deploy production
```

You're in business!
1 change: 0 additions & 1 deletion templates/arc/app.arc
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,3 @@ remix-architect-app
# @aws
# profile default
# region us-west-1

1 change: 1 addition & 0 deletions templates/arc/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
"remix": "*"
},
"devDependencies": {
"@architect/architect": "^10.0.5",
"@remix-run/dev": "*",
"@remix-run/eslint-config": "*",
"eslint": "^8.11.0",
Expand Down

0 comments on commit b0205ce

Please sign in to comment.