fix: 🐛 document and ci

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+    - package-ecosystem: npm
+      directory: "/"
+      schedule:
+          interval: monthly
+      open-pull-requests-limit: 0
+    - package-ecosystem: github-actions
+      directory: "/"
+      schedule:
+          interval: daily
+      open-pull-requests-limit: 10

.github/workflows/buildAndTest-macos.yml

@@ -0,0 +1,31 @@
+name: build and test
+on:
+    workflow_dispatch:
+    push:
+        branches: ["main"]
+    pull_request:
+        branches: ["main"]
+jobs:
+    buildAndTest:
+        runs-on: macos-latest
+        strategy:
+            matrix:
+                node-version: [18.x]
+        steps:
+            - uses: actions/checkout@v3
+            - name: Use Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@v3
+              with:
+                  node-version: ${{ matrix.node-version }}
+
+            - name: Checkout repository
+              uses: actions/checkout@v2
+            - name: Install dependencies
+              run: |
+                  npm install
+            - name: Build
+              run: |
+                  npm run build
+            - name: Test
+              run: |
+                  npm run test

.gitignore

@@ -1,2 +1,4 @@
 node_modules
 dist
+yarn.lock
+.env

.mocharc.json

@@ -0,0 +1,5 @@
+{ 
+    "loader" : "ts-node/esm",
+    "spec": "test/**/*.test.ts",
+    "exclude": ["node_modules"]
+}

.release-it.json

@@ -0,0 +1,20 @@
+{
+  "github": {
+    "release": true
+  },
+  "git": {
+    "commitMessage": "release: 🚀v${version}"
+  },
+  "npm": {
+    "publish": true
+  },
+  "hooks": {
+    "after:bump": "echo update verion successful!"
+  },
+  "plugins": {
+    "@release-it/conventional-changelog": {
+      "preset": "angular",
+      "infile": "CHANGELOG.md"
+    }
+  }
+}

CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing
+
+👍🎉 First off, thanks for taking the time to contribute! 🎉👍
+
+When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
+Please note we have a [code of conduct](https://github.com/unipackage/ddd/blob/master/.github/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
+
+## Table of Contents
+
+- [Contributing](#contributing)
+  - [Table of Contents](#table-of-contents)
+  - [Setting Up the project locally](#setting-up-the-project-locally)
+  - [Git Commit](#git-commit)
+  - [Submitting a Pull Request](#submitting-a-pull-request)
+
+## Setting Up the project locally
+
+To install the project you need to have `node` and `npm`
+
+1.  [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone
+    your fork:
+
+    ```sh
+    # Clone your fork
+    git clone https://github.com/<your-username>/ddd.git
+
+    # Navigate to the newly cloned directory
+    cd ddd 
+    ```
+
+2.  Your environment needs to be running `node` version >= 18.17.0 and `npm` version >= 10.2.0.
+
+3.  from the root of the project: `npm` to install all dependencies
+
+    - make sure you have latest `npm` version
+
+4.  from the root of the project: `npm run build` to build.
+
+5.  Your local test environment need to be setted refer to  [.evn.example](https://github.com/unipackage/ddd/blob/master/.env.example),
+    - copy [.evn.example](https://github.com/unipackage/ddd/blob/master/.env.example) to .env in root directory.
+    - modify the environment meet to your own test evnironment.
+
+## Git Commit
+Pleas use `npm run commit`
+
+## Submitting a Pull Request
+
+Please go through existing issues and pull requests to check if somebody else is already working on it.
+
+Also, make sure to run the tests and lint the code before you commit your
+changes.
+
+```sh
+npm run test
+```

LICENSE

@@ -1,6 +1,4 @@
-MIT License
-
-Copyright (c) 2023 Dataswap
+The MIT License (MIT)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +7,21 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+The APACHE License (APACHE)
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

README.md

@@ -1,2 +1,55 @@
-# ddd
-ddd
+<h1 align="center">Welcome to @unipackage/ddd 👋</h1>
+<p>
+  <a href="https://www.npmjs.com/package/@unipackage/ddd" target="_blank">
+    <img alt="Version" src="https://img.shields.io/npm/v/@unipackage/ddd.svg">
+  </a>
+  <a href="https://github.com/unipackage/ddd#readme" target="_blank">
+    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
+  </a>
+  <a href="https://github.com/unipackage/ddd/graphs/commit-activity" target="_blank">
+    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
+  </a>
+  <a href="https://github.com/unipackage/ddd/blob/master/LICENSE" target="_blank">
+    <img alt="License: MIT and APACHE" src="https://img.shields.io/badge/License-MIT and APACHE-yellow.svg" />
+  </a>
+</p>
+
+> ddd
+
+### 🏠 [Homepage](https://github.com/unipackage/ddd#readme)
+
+## Install
+
+```sh
+npm install
+```
+## Run build
+
+```sh
+npm run build
+```
+
+## Run tests
+
+```sh
+npm run test
+```
+
+## Author
+
+👤 **waynewyang**
+
+* GitHub: [@unipackage](https://github.com/unipackage):[@waynewyang](https://github.com/waynewyang)
+
+## 🤝 Contributing
+
+Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/unipackage/ddd/issues). You can also take a look at the [contributing guide](https://github.com/unipackage/ddd/blob/master/CONTRIBUTING.md).
+
+## Show your support
+
+Give a ⭐️ if this project helped you!
+
+## 📝 License
+
+Copyright © 2023 [waynewyang](https://github.com/unipackage).<br />
+This project is [MIT and APACHE](https://github.com/unipackage/ddd/blob/master/LICENSE) licensed.