create-steedos-app 2.2.52-beta.4 → 2.2.52-beta.44

package/LICENSE.txt

@@ -6,14 +6,11 @@ To determine under which license you may use a file from the Steedos source code
 please resort to the header of that file.
 
 If the file has no header, the following rules apply
-1. project templates are licensed under MIT, see License.MIT.txt
-2. enterprise features are licensed under Steedos Enterprise Terms, see License.enterprise.txt
-3. source code that is neither (1) nor (2) is licensed under AGPL, see License.AGPL.txt
+1. enterprise features are licensed under Steedos Enterprise Terms, see License.enterprise.txt
+2. source code that is neither (1) is licensed under MIT, see https://opensource.org/licenses/MIT
 
 On request, licenses under different terms are available.
 
-Project templates can be found in the folders steedos-projects/
-
 Source code of enterprise features are files that
 * are in folders named "ee" or start with "ee_", or in subfolders of such folders.
 * contain the strings "ee_" in its filename name.

package/README.md

@@ -1,2 +1,40 @@
-## 功能说明
-- 此包是npx命令`create-steedos-app`，用于创建项目，如 `npx create-steedos-app my-app`
+# Create Steedos App
+
+The easiest way to get started with Steedos Platform is by using `create-steedos-app`. This CLI tool enables you to quickly start building a new steedos application, with everything set up for you. You can create a new app using the default steedos template, or by using one of the [official Steedos examples](https://github.com/steedos/steedos-platform/tree/master/examples). To get started, use the following command:
+
+```bash
+npx create-steedos-app@latest
+# or
+yarn create steedos-app
+# or
+pnpm create steedos-app
+```
+
+To create a new app in a specific folder, you can send a name as an argument. For example, the following command will create a new Steedos app called `contract-app` in a folder with the same name:
+
+```bash
+npx create-steedos-app@latest contract-app
+# or
+yarn create steedos-app contract-app
+# or
+pnpm create steedos-app contract-app
+```
+
+## Options
+
+`create-steedos-app` comes with the following options:
+
+- **-e, --example [name]|[github-url]** - An example to bootstrap the app with. You can use an example name from the [Steedos Platform repo](https://github.com/steedos/steedos-platform/tree/master/examples) or a GitHub URL. The URL can use any branch and/or subdirectory.
+- **--example-path <path-to-example>** - In a rare case, your GitHub URL might contain a branch name with a slash (e.g. bug/fix-1) and the path to the example (e.g. foo/bar). In this case, you must specify the path to the example separately: `--example-path foo/bar`
+- **--use-npm** - Explicitly tell the CLI to bootstrap the app using npm. To bootstrap using yarn we recommend to run `yarn create steedos-app`
+- **--use-pnpm** - Explicitly tell the CLI to bootstrap the app using pnpm. To bootstrap using pnpm we recommend running `pnpm create steedos-app`
+
+## Why use Create Steedos App?
+
+`create-steedos-app` allows you to create a new Steedos Platform app within seconds. It is officially maintained by the creators of Steedos Platform, and includes a number of benefits:
+
+- **Interactive Experience**: Running `npx create-steedos-app` (with no arguments) launches an interactive experience that guides you through setting up a project.
+- **Zero Dependencies**: Initializing a project is as quick as one second. Create Steedos App has zero dependencies.
+- **Offline Support**: Create Steedos App will automatically detect if you're offline and bootstrap your project using your local package cache.
+- **Support for Examples**: Create Steedos App can bootstrap your application using an example from the Steedos Platform examples collection (e.g. `npx create-steedos-app --example api-routes`).
+- **Tested**: The package is part of the Steedos Platform monorepo and tested using the same integration test suite as Steedos Platform itself, ensuring it works as expected with every release.

package/dist/create-app.d.ts

@@ -0,0 +1,10 @@
+import type { PackageManager } from './helpers/get-pkg-manager';
+export declare class DownloadError extends Error {
+}
+export declare function createApp({ appPath, packageManager, example, examplePath, typescript, }: {
+    appPath: string;
+    packageManager: PackageManager;
+    example?: string;
+    examplePath?: string;
+    typescript?: boolean;
+}): Promise<void>;

package/dist/default/README-template.md

@@ -0,0 +1,27 @@
+This is a [Steedos](https://www.steedos.com/) project bootstrapped with [`create-steedos-app`](https://github.com/steedos/steedos-platform/tree/master/packages/create-steedos-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run start
+# or
+yarn start
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+## Learn More
+
+To learn more about Steedos Platform, take a look at the following resources:
+
+- [Steedos Documentation](https://www.steedos.com/docs) - learn about Steedos features and API.
+
+You can check out [the Steedos GitHub repository](https://github.com/steedos/steedos-platform/) - your feedback and contributions are welcome!
+
+## Deploy your project
+
+The easiest way to deploy your Steedos app is to use the [Docker Template](https://github.com/steedos/docker).
+
+Check out our [Steedos deployment documentation](https://www.steedos.com/docs/deploy/getting-started) for more details.

package/dist/default/env

@@ -0,0 +1,32 @@
+PORT=5000
+ROOT_URL=http://127.0.0.1:5000
+TRANSPORTER=redis://127.0.0.1:6379
+CACHER=redis://127.0.0.1:6379/1
+MONGO_URL=mongodb://127.0.0.1:27017/steedos
+MONGO_OPLOG_URL=mongodb://127.0.0.1:27017/local
+
+STEEDOS_CFS_STORE=local
+STEEDOS_STORAGE_DIR=./storage
+
+# 身份验证
+STEEDOS_TENANT_ENABLE_PASSWORD_LOGIN=true
+STEEDOS_TENANT_TOKEN_SECRET=change-me
+
+# 绑定华炎云账户
+STEEDOS_CLOUD_API_KEY=
+STEEDOS_CLOUD_SPACE_ID=
+
+# vscode 代码同步
+METADATA_SERVER=
+METADATA_APIKEY=
+
+# CDN in china, default is https://unpkg.com
+STEEDOS_UNPKG_URL=https://npm.elemecdn.com
+STEEDOS_PUBLIC_PAGE_ASSETURLS=https://unpkg.com/@steedos-ui/builder-widgets@2.2.32/dist/assets.json
+
+SSO_OIDC_CONFIG_URL=
+SSO_OIDC_CLIENT_ID=
+SSO_OIDC_CLIENT_SECRET=
+SSO_OIDC_NAME=
+SSO_OIDC_LOGO=
+SSO_OIDC_REQUIRE_LOCAL_ACCOUNT=false

package/dist/default/gitignore

@@ -0,0 +1,17 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+**/.DS_Store
+
+**/node_modules
+
+.npmrc
+.yarnrc
+**/npm-error.log
+**/yarn-error.log
+**/lerna-debug.log
+
+storage
+dist
+logs
+
+.env.local

package/dist/default/steedos-app/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "my-steedos-package",
+  "version": "0.1.0",
+  "main": "package.service.js",
+  "private": true
+}

package/dist/default/steedos.config.js

@@ -0,0 +1,18 @@
+module.exports = {
+	// Namespace of nodes to segment your nodes on the same network.
+	namespace: "steedos",
+	// Default log level for built-in console logger. It can be overwritten in logger options above.
+	// Available values: trace, debug, info, warn, error, fatal
+	logLevel: "warn",
+
+	// Called after broker started.
+	started(broker) {
+		// 启动 元数据服务
+		broker.createService(require("@steedos/service-metadata-server"));
+		// 启动 加载软件包服务
+		broker.createService(require("@steedos/service-package-registry"));
+		// 启动 meteor服务
+		broker.createService(require("@steedos/service-steedos-server"));
+	},
+
+};

package/dist/gitignore

@@ -0,0 +1,17 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+**/.DS_Store
+
+**/node_modules
+
+.npmrc
+.yarnrc
+**/npm-error.log
+**/yarn-error.log
+**/lerna-debug.log
+
+storage
+dist
+logs
+
+.env.local

package/dist/helpers/examples.d.ts

@@ -0,0 +1,12 @@
+export declare type RepoInfo = {
+    username: string;
+    name: string;
+    branch: string;
+    filePath: string;
+};
+export declare function isUrlOk(url: string): Promise<boolean>;
+export declare function getRepoInfo(url: URL, examplePath?: string): Promise<RepoInfo | undefined>;
+export declare function hasRepo({ username, name, branch, filePath, }: RepoInfo): Promise<boolean>;
+export declare function existsInRepo(nameOrUrl: string): Promise<boolean>;
+export declare function downloadAndExtractRepo(root: string, { username, name, branch, filePath }: RepoInfo): Promise<void>;
+export declare function downloadAndExtractExample(root: string, name: string): Promise<void>;

package/dist/helpers/get-pkg-manager.d.ts

@@ -0,0 +1,2 @@
+export declare type PackageManager = 'npm' | 'pnpm' | 'yarn';
+export declare function getPkgManager(): PackageManager;

package/dist/helpers/git.d.ts

@@ -0,0 +1 @@
+export declare function tryGitInit(root: string): boolean;

package/dist/helpers/install.d.ts

@@ -0,0 +1,22 @@
+import type { PackageManager } from './get-pkg-manager';
+interface InstallArgs {
+    /**
+     * Indicate whether to install packages using npm, pnpm or Yarn.
+     */
+    packageManager: PackageManager;
+    /**
+     * Indicate whether there is an active Internet connection.
+     */
+    isOnline: boolean;
+    /**
+     * Indicate whether the given dependencies are devDependencies.
+     */
+    devDependencies?: boolean;
+}
+/**
+ * Spawn a package manager installation with either Yarn or NPM.
+ *
+ * @returns A Promise that resolves once the installation is finished.
+ */
+export declare function install(root: string, dependencies: string[] | null, { packageManager, isOnline, devDependencies }: InstallArgs): Promise<void>;
+export {};

package/dist/helpers/is-folder-empty.d.ts

@@ -0,0 +1 @@
+export declare function isFolderEmpty(root: string, name: string): boolean;

package/dist/helpers/is-online.d.ts

@@ -0,0 +1 @@
+export declare function getOnline(): Promise<boolean>;

package/dist/helpers/is-writeable.d.ts

@@ -0,0 +1 @@
+export declare function isWriteable(directory: string): Promise<boolean>;

package/dist/helpers/make-dir.d.ts

@@ -0,0 +1,3 @@
+export declare function makeDir(root: string, options?: {
+    recursive: boolean;
+}): Promise<void>;

package/dist/helpers/validate-pkg.d.ts

@@ -0,0 +1,4 @@
+export declare function validateNpmName(name: string): {
+    valid: boolean;
+    problems?: string[];
+};

package/dist/index.d.ts

@@ -0,0 +1 @@
+export {};