add support for codesandbox projects

VulcanJS · Jun 9, 2022 · 352986b · 352986b
1 parent 074548e
commit 352986b
Show file tree

Hide file tree

Showing 2 changed files with 136 additions and 3 deletions.
diff --git a/.codesandbox/tasks.json b/.codesandbox/tasks.json
@@ -0,0 +1,125 @@
+{
+    // These tasks will run in order when initializing your CodeSandbox project.
+    // @see https://docs.codesandbox.io/our-products/codesandbox-projects/configuration-tasks#80f443ed033a4c86b79d88568ab5137e
+    // This will run 
+    "setupTasks": [
+        {
+            "name": "Install Dependencies",
+            "command": "yarn install"
+        },
+        // Usually, this step is run when doing "npx create-remix --template VulcanJS/eurodance-stack
+        // However, CodeSandbox or StackBlitz have a git clone based install process, so it must be run manually
+        {
+            "name": "Remix init",
+            "command": "yarn remix init"
+        }
+    ],
+    // These tasks can be run from CodeSandbox. Running one will open a log in the app.
+    // Optionally enable commands from package.json here
+    "tasks": {
+        "postinstall": {
+            "name": "postinstall",
+            "command": "yarn postinstall",
+            "runAtStart": false
+        },
+        "build": {
+            "name": "build",
+            "command": "yarn build",
+            "runAtStart": false
+        },
+        "build:vercel": {
+            "name": "build:vercel",
+            "command": "yarn build:vercel",
+            "runAtStart": false
+        },
+        "build:css": {
+            "name": "build:css",
+            "command": "yarn build:css",
+            "runAtStart": false
+        },
+        "build:remix": {
+            "name": "build:remix",
+            "command": "yarn build:remix",
+            "runAtStart": false
+        },
+        "dev": {
+            "name": "dev",
+            "command": "yarn dev",
+            "runAtStart": true
+        },
+        "dev:css": {
+            "name": "dev:css",
+            "command": "yarn dev:css",
+            "runAtStart": false
+        },
+        "dev:remix": {
+            "name": "dev:remix",
+            "command": "yarn dev:remix",
+            "runAtStart": false
+        },
+        "format": {
+            "name": "format",
+            "command": "yarn format",
+            "runAtStart": false
+        },
+        "generate:css": {
+            "name": "generate:css",
+            "command": "yarn generate:css",
+            "runAtStart": false
+        },
+        "lint": {
+            "name": "lint",
+            "command": "yarn lint",
+            "runAtStart": false
+        },
+        "setup": {
+            "name": "setup",
+            "command": "yarn setup",
+            "runAtStart": false
+        },
+        "start": {
+            "name": "start",
+            "command": "yarn start",
+            "runAtStart": false
+        },
+        "start:mocks": {
+            "name": "start:mocks",
+            "command": "yarn start:mocks",
+            "runAtStart": false
+        },
+        "test": {
+            "name": "test",
+            "command": "yarn test",
+            "runAtStart": false
+        },
+        "test:e2e:dev": {
+            "name": "test:e2e:dev",
+            "command": "yarn test:e2e:dev",
+            "runAtStart": false
+        },
+        "pretest:e2e:run": {
+            "name": "pretest:e2e:run",
+            "command": "yarn pretest:e2e:run",
+            "runAtStart": false
+        },
+        "test:e2e:run": {
+            "name": "test:e2e:run",
+            "command": "yarn test:e2e:run",
+            "runAtStart": false
+        },
+        "typecheck": {
+            "name": "typecheck",
+            "command": "yarn typecheck",
+            "runAtStart": false
+        },
+        "validate": {
+            "name": "validate",
+            "command": "yarn validate",
+            "runAtStart": false
+        },
+        "yarn remix init": {
+            "name": "yarn remix init",
+            "command": "yarn remix init"
+        }
+    }
+}
diff --git a/README.md b/README.md
@@ -5,13 +5,17 @@ _Based on Remix [Indie Stack](https://github.com/remix-run/indie-stack)_
 
 <!--![The Remix Eurodance Stack](https://repository-images.githubusercontent.com/465928257/a241fa49-bd4d-485a-a2a5-5cb8e4ee0abf)-->
 
+Eurodance Stack is the Remix stack for **GraphQL** developers.
+
 Learn more about [Remix Stacks](https://remix.run/stacks).
 
 ```
 npx create-remix --template VulcanJS/eurodance-stack
 ```
 
-**NOTE: if you clone this repo directly, and don't use `create-remix`, you will need to run `yarn remix init` manually!**
+You can also run Eurodance Stack on [CodeSandbox Projects](https://projects.codesandbox.io/). As it is currently in beta (06/2022), you need to ask for an early access, and then search for "VulcanJS/eurodance-stack" when creating your project.
+
+**NOTE: if you clone this repo directly, and don't use `create-remix`, you will need to run `yarn remix init` manually after the first install!**
 
 ## What's in the stack
 
@@ -37,14 +41,18 @@ For historical reasons Vulcan prefers Vercel, but you can deploy your Remix app
 - If using SQLite, set `DATABASE_URL` to `file:./tmp/data/data.db?connection_limit=1`. **Important note: the data will not persist!**
 **This is only for demonstration purpose.** You should find an host that supports SQLite or wait until we introduce MongoDB in this stack.
 
+**CodeSandbox Projects**
+
+Eurodance supports being installed as a CodeSandbox Project (beta feature).
+
 ### Incoming
 
 **MongoDB supports (via Prisma)**
 
 Remix stacks works with Prisma out-of-the-box, and various databases.
 For historical reasons, Vulcan prefers Mongo, but you can switch very easily to any database.
 
-**Advnaced GraphQL**
+**Advanced GraphQL**
 
 - A GraphQL resource route with [GraphQL Yoga](https://www.graphql-yoga.com/)
 - Vulcan Fire Engine
@@ -55,7 +63,7 @@ For historical reasons, Vulcan prefers Mongo, but you can switch very easily to
 
 [And many others, follow the umbrella ticket on GitHub to learn more about our roadmap.](https://github.com/VulcanJS/vulcan-npm/issues/117)
 
-### From Remix indie stack:
+### Features inherited from Remix Indie stack:
 
 - [Fly app deployment](https://fly.io) with [Docker](https://www.docker.com/)
 - Production-ready [SQLite Database](https://sqlite.org)