Skip to content

Commit 9cf86b4

Browse files
joshuamindjoshuamind
committed
v1.0.0 release
init first public release publish to npmjs add example
0 parents  commit 9cf86b4

36 files changed

Lines changed: 17477 additions & 0 deletions

‎.fatherrc.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import { defineConfig } from 'father';
2+
3+
export default defineConfig({
4+
esm: {output: 'dist'},
5+
cjs: {output: 'dist'},
6+
prebundle: {},
7+
});

‎.gitignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
/node_modules
2+
/dist
3+
.DS_Store
4+
.idea
5+
.editorconfig
6+
example/src/myconfig.ts
7+
.npmrc

‎.prettierignore‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
**/*.md
2+
**/*.svg
3+
**/*.ejs
4+
**/*.html
5+
package.json
6+
.umi
7+
.umi-production
8+
.umi-test
9+
.dist
10+
.node_modules

‎.prettierrc‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"singleQuote": true,
3+
"trailingComma": "all",
4+
"printWidth": 80,
5+
"overrides": [
6+
{
7+
"files": ".prettierrc",
8+
"options": { "parser": "json" }
9+
}
10+
]
11+
}

‎LICENSE‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
MIT License
2+
3+
Copyright (c) 2021 The Typescript Packaging Authority
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
7+
furnished to do so, subject to the following conditions:
8+
9+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
10+
11+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15+
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 THESOFTWARE.

‎README.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Mind Lake Typescript SDK
2+
3+
An Typescript implementation for Mind Lake
4+
5+
## Description
6+
7+
The Mind Lake SDK utilizes Mind Lake's encryption storage and privacy computing capabilities to provide secure data management.
8+
* Mind Lake is the backbone of Mind Network.
9+
* All data is end-to-end encrypted at the client-side SDK side, ensuring that plaintext data never leaves the user's client.
10+
* Cryptographic principles ensure that only the data owner can access their own plaintext data.
11+
* Additionally, Mind Lake's powerful privacy computing capabilities enable the performance of calculations and querying of encrypted data.
12+
13+
## Getting Started
14+
15+
### Dependencies
16+
17+
* node [16, 18)
18+
* web3js
19+
20+
### Installing
21+
22+
```
23+
$ npm install --save mind-lake-sdk
24+
# or
25+
$ yarn add mind-lake-sdk
26+
```
27+
28+
### Executing program
29+
30+
* [quick starts](https://mind-network.gitbook.io/mind-lake-sdk/get-started)
31+
* [more examples](https://mind-network.gitbook.io/mind-lake-sdk/use-cases)
32+
* Step-by-step bullets
33+
```
34+
import { MindLake } from "mind-lake-sdk";
35+
const mindLake = await MindLake.getInstance("YOUR OWN APP KEY")
36+
...
37+
```
38+
39+
## code
40+
```
41+
mind-lake-sdk-typescript
42+
|-- src # source code
43+
| |-- MindLake.ts
44+
| |-- DataLake.ts
45+
| |-- Permission.ts
46+
| |-- Cryptor.ts
47+
|-- tests # unit test code
48+
|-- example # use case examples
49+
|-- README.md
50+
└--- LICENSE
51+
52+
```
53+
54+
## Help
55+
56+
Full doc: [https://mind-network.gitbook.io/mind-lake-sdk](https://mind-network.gitbook.io/mind-lake-sdk)
57+
58+
## Authors
59+
* Joshua [@JoshuaW55818202](https://twitter.com/JoshuaW55818202)
60+
* Lee [@LeeTan853917](https://twitter.com/LeeTan853917)
61+
62+
## Version History
63+
64+
* v1.0.0
65+
* Initial Release
66+
67+
## License
68+
69+
This project is licensed under the [MIT] License - see the LICENSE.md file for details

‎example/.gitignore‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/npm-debug.log*
6+
/yarn-error.log
7+
/yarn.lock
8+
/package-lock.json
9+
.editorconfig
10+
11+
# production
12+
/dist
13+
14+
# misc
15+
.DS_Store
16+
17+
# umi
18+
/src/.umi
19+
/src/.umi-production
20+
/src/.umi-test
21+
/.env.local

‎example/.prettierignore‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
**/*.md
2+
**/*.svg
3+
**/*.ejs
4+
**/*.html
5+
package.json
6+
.umi
7+
.umi-production
8+
.umi-test

‎example/.prettierrc‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"singleQuote": true,
3+
"trailingComma": "all",
4+
"printWidth": 80,
5+
"overrides": [
6+
{
7+
"files": ".prettierrc",
8+
"options": { "parser": "json" }
9+
}
10+
]
11+
}

‎example/.umirc.ts‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import { defineConfig } from 'umi';
2+
3+
export default defineConfig({
4+
nodeModulesTransform: {
5+
type: 'none',
6+
},
7+
routes: [
8+
{ path: '/', component: '@/pages/index' },
9+
],
10+
fastRefresh: {},
11+
});

0 commit comments

Comments
 (0)