{"id":19437879,"url":"https://github.com/architect/plugin-remix","last_synced_at":"2025-09-04T19:26:09.868Z","repository":{"id":40759442,"uuid":"458355636","full_name":"architect/plugin-remix","owner":"architect","description":"Architect plugin for Remix.","archived":false,"fork":false,"pushed_at":"2022-04-30T15:35:03.000Z","size":114,"stargazers_count":13,"open_issues_count":3,"forks_count":1,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-10-07T16:04:49.990Z","etag":null,"topics":["architect","remix-run","serverless"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@architect/plugin-remix","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/architect.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":".github/code_of_conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-02-11T22:14:55.000Z","updated_at":"2024-09-30T00:09:05.000Z","dependencies_parsed_at":"2022-07-29T09:40:00.288Z","dependency_job_id":null,"html_url":"https://github.com/architect/plugin-remix","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/architect%2Fplugin-remix","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/architect%2Fplugin-remix/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/architect%2Fplugin-remix/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/architect%2Fplugin-remix/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/architect","download_url":"https://codeload.github.com/architect/plugin-remix/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223968120,"owners_count":17233445,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["architect","remix-run","serverless"],"created_at":"2024-11-10T15:16:10.448Z","updated_at":"2024-11-10T15:16:10.980Z","avatar_url":"https://github.com/architect.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg alt=\"Architect logo light\" src=\"https://github.com/architect/assets.arc.codes/raw/main/public/architect-logo-light-500b%402x.png#gh-dark-mode-only\" width=\"500\" class=\"dn\"\u003e\n  \u003cimg alt=\"Architect logo\" src=\"https://github.com/architect/assets.arc.codes/raw/main/public/architect-logo-500b%402x.png#gh-light-mode-only\" width=\"500\"\u003e\n\u003c/div\u003e\n\n## [`@architect/plugin-remix`](https://www.npmjs.com/package/@architect/plugin-remix)\n\n\u003e Mix [Remix](https://remix.run) into an [Architect](https://arc.codes) project.\n\n[![GitHub CI status](https://github.com/architect/plugin-remix/workflows/Node%20CI/badge.svg)](https://github.com/architect/plugin-remix/actions?query=workflow%3A%22Node+CI%22)\n\n## Install\n\n\u003e ⚠️  This plugin is still pre-v1. Give it a go and provide any feedback by filing an issue.\n\nInto your existing Architect project:\n\n```sh\nnpm i @architect/plugin-remix --save-dev\n```\n\nAdd the following to your Architect project manifest (usually `app.arc`):\n\n```arc\n@plugins\narchitect/plugin-remix\n\n@remix\n```\n\nCreate a `remix.config.js` in your Architect project root:\n\n```js\n// ./remix.config.js\n\nmodule.exports = {}\n```\n\n## Requirements\n\nArchitect 10+\n\n## Examples\n\nSee examples/ for sample apps.\n\n- [Simple app](https://github.com/architect/plugin-remix/tree/main/examples/simple): A baseline app without custom configuration.\n- [Advanced app](https://github.com/architect/plugin-remix/tree/main/examples/advanced): An example that uses all plugin options with a slightly more complex Remix app.\n\n## How it works\n\n`@architect/plugin-remix` is an [Architect](https://arc.codes) (v10+) plugin that automatically integrates the [Remix framework](https://remix.run) into an Arc project.\n\nTo achieve this, the plugin hooks into Architect's local development Sandbox and deployment commands in order to build and serve a Remix project (from ./app by default).\n\nThis plugin automatically configures and uses Remix's built-in watcher as a sub-process of Architect's Sandbox.\n\nThe following directories are automatically managed (see [configuration](#configuration) for options):\n\n- `./.build/` directory will be created at the project root for the Remix server (deployed as a Lambda) and cache.\n- `./public/.build/` dir will be created for Remix assets (deployed to an S3 bucket).\n\n## Configuration\n\nAvailable plugin options and their defaults:\n\n```sh\n@remix\napp-directory app\nbuild-directory .remix\n```\n\n- `app-directory` - folder path. Specify where your Remix app lives.\n- `build-directory` - folder name. Name of folder for both server and client builds.\n- `server-handler` - (advanced usage!) Javascript file path. Use a custom Lambda handler to load the Remix server. A recommended handler is provided by default when this option is not set.\n- `mount` - Broken! - Specify a route to mount the Remix server. WIP.\n\n### Interaction with remix.config.js\n\n`@architect/plugin-remix` makes its best effort to respect a project's existing remix.config.js, but does control Remix build directories to better integrate with Architect.\n\nBased on plugin defaults and plugin configuration (via `@remix` in `app.arc`), the following options are mutated before being passed to Remix:\n\n```\nappDirectory\nassetsBuildDirectory\ncacheDirectory\npublicPath\nserverBuildPath\n```\n\n## Known Issues\n\n- `createArcTableSessionStorage` from `@remix-run/architect` hasn't been validated in this plugin yet.\n- \"`ExperimentalWarning: stream/web is an experimental feature.`\" messages pollute the console.\n  - This is an issue upstream of Architect and Remix: https://github.com/remix-run/remix/issues/1141\n- Architect Sandbox will warn \"`Warning: You may have dependencies that could be inaccessible in production`\" when the Remix server isn't hydrated.\n  - Either ignore or run `npx arc hydrate` after an initial Remix build has been run (via running Sandbox or an `arc deploy`)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farchitect%2Fplugin-remix","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farchitect%2Fplugin-remix","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farchitect%2Fplugin-remix/lists"}