From ae350770de14b8d0522505355b9f3567d84662c6 Mon Sep 17 00:00:00 2001 From: Ryan Block Date: Fri, 4 Mar 2022 14:04:43 -0800 Subject: [PATCH 1/4] Readme + dependency updates --- packages/create-remix/templates/arc/README.md | 43 ++++++++++--------- .../create-remix/templates/arc/package.json | 1 + 2 files changed, 24 insertions(+), 20 deletions(-) diff --git a/packages/create-remix/templates/arc/README.md b/packages/create-remix/templates/arc/README.md index 676a6db433c..e26c4052dbc 100644 --- a/packages/create-remix/templates/arc/README.md +++ b/packages/create-remix/templates/arc/README.md @@ -2,37 +2,40 @@ - [Remix Docs](https://remix.run/docs) -## Architect Setup -When deploying to AWS Lambda with Architect, you'll need: +## Development -- Architect (`arc`) CLI -- AWS SDK +Both Remix and Architect have their own local servers, each of which is responsible for unique tasks related to local development. -Architect recommends installing these globally: +To start t both alongside one another, run: ```sh -$ npm i -g @architect/architect aws-sdk +$ npm run dev ``` -## Development +Open up [http://localhost:3333](http://localhost:3333) and you should be ready to go! -You will be running two processes during development when using Architect as your server. +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. -- Your Architect server sandbox in one -- The Remix development server in another -```sh -# in one tab -$ arc sandbox +### TypeScript -# in another -$ npm run dev +To develop in TypeScript, install Architect's official TS plugin: + +```sh +$ npm i @architect/plugin-typescript ``` -Open up [http://localhost:3333](http://localhost:3333) and you should be ready to go! +Then add the following to the `app.arc` file: + +```arc +@plugins +architect/plugin-typescript + +@aws +runtime typescript +``` -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. ## Deploying @@ -41,9 +44,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 @@ -52,7 +55,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! diff --git a/packages/create-remix/templates/arc/package.json b/packages/create-remix/templates/arc/package.json index 9b91a5a57d5..8a487f67237 100644 --- a/packages/create-remix/templates/arc/package.json +++ b/packages/create-remix/templates/arc/package.json @@ -8,6 +8,7 @@ "start": "cross-env NODE_ENV=production arc sandbox" }, "dependencies": { + "@architect/architect": "^10.0.5", "@remix-run/architect": "*", "cross-env": "^7.0.3" }, From 4a874a37c559c960cc2a971cc775097798971efb Mon Sep 17 00:00:00 2001 From: Ryan Block Date: Fri, 4 Mar 2022 14:06:58 -0800 Subject: [PATCH 2/4] Add ryanblock to contributors --- contributors.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/contributors.yml b/contributors.yml index 02b8fca83b6..805c9b2b4e0 100644 --- a/contributors.yml +++ b/contributors.yml @@ -229,6 +229,7 @@ - rtabulov - Runner-dev - rvlewerissa +- ryanblock - ryanflorence - ryankshaw - sandulat From 5fe65e713a236a14bcc2ca644e3eea0dab2b41d1 Mon Sep 17 00:00:00 2001 From: Ryan Block Date: Fri, 4 Mar 2022 14:10:09 -0800 Subject: [PATCH 3/4] Readme update --- packages/create-remix/templates/arc/README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/packages/create-remix/templates/arc/README.md b/packages/create-remix/templates/arc/README.md index e26c4052dbc..cbe2c95471a 100644 --- a/packages/create-remix/templates/arc/README.md +++ b/packages/create-remix/templates/arc/README.md @@ -7,7 +7,7 @@ Both Remix and Architect have their own local servers, each of which is responsible for unique tasks related to local development. -To start t both alongside one another, run: +To start both alongside one another, run: ```sh $ npm run dev @@ -15,8 +15,6 @@ $ 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. - ### TypeScript From a53e215073ebf93ed9820d45017ef001f430574d Mon Sep 17 00:00:00 2001 From: Ryan Block Date: Fri, 4 Mar 2022 14:11:45 -0800 Subject: [PATCH 4/4] TS link --- packages/create-remix/templates/arc/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/create-remix/templates/arc/README.md b/packages/create-remix/templates/arc/README.md index cbe2c95471a..429f4795c27 100644 --- a/packages/create-remix/templates/arc/README.md +++ b/packages/create-remix/templates/arc/README.md @@ -34,6 +34,8 @@ architect/plugin-typescript runtime typescript ``` +Head here to learn more about [developing in TypeScript with Architect](https://arc.codes/docs/en/guides/developer-experience/using-typescript). + ## Deploying