create-openfort 0.0.13 → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## 0.1.0
+
+### Minor Changes
+
+- [#97](https://github.com/openfort-xyz/openfort-react/pull/97) [`023e3b4`](https://github.com/openfort-xyz/openfort-react/commit/023e3b43c7374792391df8388336e9e7a8dc3d8b) Thanks [@Huguet57](https://github.com/Huguet57)! - Optimized internal configuration
+
+## 0.1.0
+
+### Initial Release
+
+- Initial release of create-openfort CLI
+- Support for multiple authentication providers (Firebase, Headless, Openfort UI)
+- Backend integration with Openfort SDK
+- TypeScript support out of the box
+- Modern development experience with Vite and React

package/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2022, LFE, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,64 @@
+<h1 align="center">
+  create-openfort
+</h1>
+
+<p align="center">
+  Interactive CLI to start a Web3 app with Openfort embedded wallets.
+</p>
+
+<p align="center">
+  Get started by running <code>npm create openfort-app@latest</code>
+</p>
+
+## Table of contents
+
+- <a href="#about">About</a>
+- <a href="#getting-started">Getting Started</a>
+- <a href="#community">Community</a>
+- <a href="#contributors">Contributors</a>
+
+<h2 id="about">Create Openfort App</h2>
+
+`create-openfort` is a CLI tool to quickly scaffold Web3 applications with Openfort's embedded wallet infrastructure. Build blockchain-enabled apps with ease using modern frameworks and best practices.
+
+### Features
+
+- Interactive CLI for quick project setup
+- Support for multiple authentication providers (Firebase, Headless, Openfort UI)
+- Backend integration with Openfort SDK
+- TypeScript support out of the box
+- Modern development experience with Vite and React
+
+<h2 id="getting-started">Getting Started</h2>
+
+To scaffold an app using `create-openfort`, run any of the following commands:
+
+### npm
+
+```bash
+npm create openfort@latest
+```
+
+### yarn
+
+```bash
+yarn create openfort
+```
+
+### pnpm
+
+```bash
+pnpm create openfort@latest
+```
+
+### bun
+
+```bash
+bun create openfort@latest
+```
+
+<h2 id="community">Community</h2>
+
+For help, discussion about best practices, or any other conversation that would benefit create-openfort:
+
+[Join the Openfort Telegram Group](https://t.me/openfort)

package/package.json

@@ -1,44 +1,63 @@
 {
   "name": "create-openfort",
-  "version": "0.0.13",
-  "type": "module",
+  "version": "0.1.0",
+  "description": "Create Openfort applications with embedded wallets",
   "license": "MIT",
   "author": "Openfort (https://www.openfort.xyz)",
-  "bin": "index.js",
-  "files": [
-    "index.js",
-    "dist"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/openfort-xyz/openfort-react.git",
+    "directory": "packages/create-openfort"
+  },
+  "keywords": [
+    "create-openfort",
+    "openfort",
+    "embedded-wallets",
+    "web3",
+    "blockchain",
+    "react",
+    "vite",
+    "typescript"
   ],
-  "scripts": {
-    "dev": "unbuild --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:ui": "vitest --ui",
-    "test:coverage": "vitest run --coverage",
-    "test:integration": "node -e \"require('fs').mkdirSync('tests', { recursive: true });\" && cd tests && node ./../index.js",
-    "build": "unbuild && node build.js",
-    "lint": "tsc --noEmit"
+  "type": "module",
+  "exports": "./dist/index.js",
+  "bin": {
+    "create-openfort": "./dist/index.js"
   },
+  "files": [
+    "dist",
+    "template",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md",
+    ".yarnrc.yml",
+    "package.json"
+  ],
   "engines": {
-    "node": "^18.0.0 || ^20.0.0 || >=22.0.0"
+    "node": ">=18.17.0"
+  },
+  "dependencies": {
+    "@clack/prompts": "^0.6.3",
+    "chalk": "5.2.0",
+    "commander": "^10.0.1",
+    "execa": "^7.2.0",
+    "fs-extra": "^11.2.0",
+    "gradient-string": "^2.0.2",
+    "ora": "6.3.1"
   },
   "devDependencies": {
-    "@clack/prompts": "^0.10.0",
-    "@openfort/react": "^0.0.17",
-    "@types/cross-spawn": "^6.0.6",
-    "@types/node": "^24.7.0",
-    "@vitest/coverage-v8": "^3.2.4",
-    "@vitest/ui": "^3.2.4",
-    "cross-spawn": "^7.0.6",
-    "mri": "^1.2.0",
-    "node-fetch": "^3.3.2",
-    "picocolors": "^1.1.1",
-    "react": "^18.0.0",
-    "react-dom": "^18.0.0",
-    "typescript": "^5.0.4",
-    "unbuild": "^3.5.0",
-    "viem": "^2.23.2",
-    "vitest": "^3.2.4",
-    "wagmi": "^2.14.11"
+    "@biomejs/biome": "^2.2.4",
+    "@types/fs-extra": "^11.0.4",
+    "@types/gradient-string": "^1.1.6",
+    "@types/node": "^20.14.10",
+    "tsup": "^6.7.0",
+    "type-fest": "^3.13.1",
+    "typescript": "^5.8.2"
+  },
+  "scripts": {
+    "check": "tsc && biome check",
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "start": "node dist/index.js"
   }
-}
+}

package/template/backend/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.{js,json,yml}]
+charset = utf-8
+indent_style = space
+indent_size = 2

package/template/backend/.env.example

@@ -0,0 +1,6 @@
+OPENFORT_SECRET_KEY=
+SHIELD_API_KEY=
+SHIELD_SECRET_KEY=
+SHIELD_ENCRYPTION_SHARE=
+
+PORT=

package/template/backend/.gitattributes

@@ -0,0 +1,4 @@
+/.yarn/**            linguist-vendored
+/.yarn/releases/*    binary
+/.yarn/plugins/**/*  binary
+/.pnp.*              binary linguist-generated

package/template/backend/README.md

@@ -0,0 +1,35 @@
+# Openfort backend quickstart
+
+This is a sample for a simple backend to create an encryption session for [openfort Signer](https://www.openfort.io/docs/guides/javascript/embedded-signer/recovery)
+
+## Set up
+
+1. **Copy environment variables:**
+
+    ```sh
+    cp .env.example .env
+    ```
+
+    Edit `.env` and set the required variables
+
+2. **Install dependencies:**
+
+    ```sh
+    pnpm install
+    ```
+
+3. **Start the development server:**
+
+    ```sh
+    pnpm dev
+    ```
+
+## What does it provide?
+
+Do a post to `/api/protected-create-encryption-session` and you will response a session like:
+
+```json
+  {
+    "session": "cb44a4a1-5867-4b25-b5a0-57b496e14d78"
+  }
+```

package/template/backend/biome.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
+  },
+  "files": {
+    "ignoreUnknown": false,
+    "ignore": ["node_modules", "dist", "build", "*.log"]
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineWidth": 100
+  },
+  "organizeImports": {
+    "enabled": true
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "semicolons": "always"
+    }
+  }
+}

package/template/backend/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "auth-sample-backend",
+  "packageManager": "pnpm@9.15.4",
+  "dependencies": {
+    "@openfort/openfort-node": "^0.6.75",
+    "cors": "^2.8.5",
+    "express": "^4.21.2"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^1.9.4",
+    "@types/cors": "^2.8.17",
+    "@types/express": "^5.0.0",
+    "@types/node": "^22.13.5",
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.7.3"
+  },
+  "scripts": {
+    "build": "tsc",
+    "start": "node dist/app.js",
+    "dev": "ts-node-dev src/app.ts",
+    "format": "biome format --write .",
+    "lint": "biome lint .",
+    "check": "biome check --write ."
+  }
+}