Flaschengeist
/
flaschengeist-balance
7
0
Fork 0
Code Issues Pull Requests Projects Releases Activity

[docs][core] Added README and API types

This commit is contained in:
Ferdinand Thiessen 2021-05-26 18:59:03 +02:00
parent 9bf9c67b5a
commit 3e51f0b751
3 changed files with 35 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md Normal file
View File

@ -0,0 +1,13 @@
# Flaschengeist `users` fontend-plugin
This package provides the [Flaschengeist](https://flaschengeist.dev/Flaschengeist/flaschengeist) frontend for the `balance` plugin.
## License
Licensed under the MIT license, see [LICENSE](./LICENSE) for more details.
## Development
Feel free to report bugs, issues and feature requests using the [Issues function](https://flaschengeist.dev/Flaschengeist/flaschengeist/issues).
Please follow our [general development guide](https://flaschengeist.dev/Flaschengeist/flaschengeist/wiki/Development#general-development).

21
package.json
View File

@ -1,9 +1,8 @@
{ {
"private": true,
"license": "MIT", "license": "MIT",
"version": "1.0.0-alpha.1", "version": "1.0.0-alpha.1",
"name": "@flaschengeist/balance", "name": "@flaschengeist/balance",
"author": "Ferdinand <rpm@fthiessen.de>", "author": "Ferdinand Thiessen <rpm@fthiessen.de>",
"homepage": "https://flaschengeist.dev/Flaschengeist", "homepage": "https://flaschengeist.dev/Flaschengeist",
"description": "Flaschengeist balance plugin", "description": "Flaschengeist balance plugin",
"bugs": { "bugs": {
@ -14,24 +13,24 @@
"url": "https://flaschengeist.dev/Flaschengeist/flaschengeist-balance" "url": "https://flaschengeist.dev/Flaschengeist/flaschengeist-balance"
}, },
"main": "src/index.ts", "main": "src/index.ts",
"types": "src/api.d.ts",
"scripts": { "scripts": {
"valid": "tsc --noEmit",
"pretty": "prettier --config ./package.json --write '{,!(node_modules)/**/}*.ts'", "pretty": "prettier --config ./package.json --write '{,!(node_modules)/**/}*.ts'",
"lint": "eslint --ext .js,.ts,.vue ./src" "lint": "eslint --ext .js,.ts,.vue ./src"
}, },
"devDependencies": { "devDependencies": {
"@flaschengeist/types": "git+https://flaschengeist.dev/ferfissimo/flaschengeist-types.git#develop", "@flaschengeist/types": "^1.0.0-alpha.1",
"@quasar/app": "^3.0.0-beta.25", "@quasar/app": "^3.0.0-beta.25",
"axios": "^0.21.1",
"prettier": "^2.3.0",
"typescript": "^4.2.4",
"pinia": "^2.0.0-alpha.19",
"quasar": "^2.0.0-beta.18",
"@typescript-eslint/eslint-plugin": "^4.24.0", "@typescript-eslint/eslint-plugin": "^4.24.0",
"@typescript-eslint/parser": "^4.24.0", "@typescript-eslint/parser": "^4.24.0",
"axios": "^0.21.1",
"eslint": "^7.26.0", "eslint": "^7.26.0",
"eslint-config-prettier": "^8.3.0", "eslint-config-prettier": "^8.3.0",
"eslint-plugin-vue": "^7.9.0" "eslint-plugin-vue": "^7.9.0",
"pinia": "^2.0.0-alpha.19",
"prettier": "^2.3.0",
"quasar": "^2.0.0-beta.18",
"typescript": "^4.2.4"
}, },
"peerDependencies": { "peerDependencies": {
"@flaschengeist/api": "1.0.0-alpha.1", "@flaschengeist/api": "1.0.0-alpha.1",
@ -40,7 +39,7 @@
"prettier": { "prettier": {
"singleQuote": true, "singleQuote": true,
"semi": true, "semi": true,
"printWidth": 100, "printWidth": 120,
"arrowParens": "always" "arrowParens": "always"
} }
} }

12
src/api.d.ts vendored Normal file
View File

@ -0,0 +1,12 @@
declare namespace FG {
interface Transaction {
id: number;
time: Date;
amount: number;
reversal_id?: number;
author_id?: string;
sender_id?: string;
original_id?: number;
receiver_id?: string;
}
}