Merge pull request #1 from FeatureProbe/feature-init

feat: SDK 1.0.1

Author: frankzhaopeng

.gitignore

@@ -0,0 +1,10 @@
+dist/
+build/
+coverage
+node_modules/
+yarn.lock
+.DS_Store
+lib
+.idea
+.vscode/
+.husky/

README.md

@@ -1,2 +1,35 @@
-# client-sdk-react
-FeatureProbe Client Side SDK for React
+# FeatureProbe Client Side SDK for React
+
+[![Top Language](https://img.shields.io/github/languages/top/FeatureProbe/client-sdk-react)](https://github.com/FeatureProbe/client-sdk-react/search?l=rust)
+[![Coverage Status](https://coveralls.io/repos/github/FeatureProbe/client-sdk-react/badge.svg?branch=main)](https://coveralls.io/github/FeatureProbe/client-sdk-react?branch=main)
+[![Github Star](https://img.shields.io/github/stars/FeatureProbe/client-sdk-react)](https://github.com/FeatureProbe/client-sdk-react/stargazers)
+[![Apache-2.0 license](https://img.shields.io/github/license/FeatureProbe/FeatureProbe)](https://github.com/FeatureProbe/FeatureProbe/blob/main/LICENSE)
+
+FeatureProbe is an open source feature management service. This SDK is used to control features in React programs. This
+SDK is designed primarily for use in multi-user systems such as web servers and applications.
+
+## Basic Terms
+
+Reading the short [Basic Terms](https://github.com/FeatureProbe/FeatureProbe/blob/main/BASIC_TERMS.md) will help to understand the code blow more easily.  [中文](https://github.com/FeatureProbe/FeatureProbe/blob/main/BASIC_TERMS_CN.md)
+
+## Core Data Structures
+
+Reading the short [Doc](https://github.com/FeatureProbe/feature-probe-docs/blob/b8c55a35c771e4223469f1b121f8b78ab3d9bc22/docs/sdk/sdk-introduction.md?plain=1#L13-L34) about core data sturtures. [中文](https://github.com/FeatureProbe/feature-probe-docs/blob/b8c55a35c771e4223469f1b121f8b78ab3d9bc22/i18n/zh-CN/docusaurus-plugin-content-docs/current/sdk/sdk-introduction.md?plain=1#L14-L35)
+
+## How to use this SDK
+
+See [SDK Doc](https://docs.featureprobe.io/how-to/Client-Side%20SDKs/react-sdk/) for detail（[中文](https://docs.featureprobe.io/zh-CN/how-to/Client-Side%20SDKs/react-sdk/)）. For more information about SDK API, please reference [SDK API](https://featureprobe.github.io/client-sdk-react/).
+
+
+## Contributing
+
+We are working on continue evolving FeatureProbe core, making it flexible and easier to use.
+Development of FeatureProbe happens in the open on GitHub, and we are grateful to the
+community for contributing bugfixes and improvements.
+
+Please read [CONTRIBUTING](https://github.com/FeatureProbe/featureprobe/blob/master/CONTRIBUTING.md)
+for details on our code of conduct, and the process for taking part in improving FeatureProbe.
+
+## License
+
+This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.

commitlint.config.js

@@ -0,0 +1 @@
+module.exports = {extends: ['@commitlint/config-conventional']}

config/tsconfig.cjs.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../tsconfig",
+  "compilerOptions": {
+    "module": "commonjs",
+    "outDir": "../dist/cjs"
+  }
+}

config/tsconfig.esm.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../tsconfig",
+  "compilerOptions": {
+    "module": "ESNext",
+    "outDir": "../dist/esm"
+  }
+}

config/tsconfig.types.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../tsconfig",
+  "compilerOptions": {
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "outDir": "../dist/types"
+  }
+}

config/tsconfig.umd.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../tsconfig",
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": false
+  }
+}

config/webpack.config.js

@@ -0,0 +1,30 @@
+const path = require('path')
+
+module.exports = {
+  mode: 'production',
+  entry: './src/index.ts',
+  output: {
+    path: path.resolve(__dirname, '../dist/umd'),
+    filename: 'index.js',
+    library: 'exampleTypescriptPackage',
+    libraryTarget: 'umd',
+    globalObject: 'this',
+  },
+  module: {
+    rules: [
+      {
+        test: /\.ts(x*)?$/,
+        exclude: /node_modules/,
+        use: {
+          loader: 'ts-loader',
+          options: {
+            configFile: 'config/tsconfig.umd.json',
+          },
+        },
+      },
+    ],
+  },
+  resolve: {
+    extensions: ['.ts', '.js'],
+  },
+}

docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/assets/highlight.css

@@ -0,0 +1,22 @@
+:root {
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --code-background: var(--dark-code-background);
+}
+
+pre, code { background: var(--code-background); }