{"_id":"@alexintosh/assetallocator","_rev":"2-a00e13e54f0b4b21ffe06a267d666ce8","name":"@alexintosh/assetallocator","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@alexintosh/assetallocator","version":"0.0.1","description":"Creates allocation of crypto coins based on market data","author":{"name":"Alessio Delmonti","email":"alessio.d@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/Alexintosh/AssetAllocator.js.git"},"license":"MIT","keywords":["defi","piedao","assets"],"main":"./dist/tsc/main.js","types":"./dist/tsc/main.d.ts","browser":"./dist/esbuild/browser.js","bin":{"my-cli-tool":"dist/esbuild/cli.js"},"scripts":{"cli":"ts-node src/cli.ts","lint":"eslint src/ --ext .js,.jsx,.ts,.tsx","test":"jest","clean":"rm -rf dist build package","ts-node":"ts-node","docs":"typedoc --entryPoints src/main.ts","build":"tsc -p tsconfig.json","build-all":"yarn clean && yarn build && yarn esbuild-node && yarn esbuild-browser","esbuild-browser":"esbuild src/browser.ts --bundle --minify --sourcemap=external --outfile=dist/esbuild/browser.js","esbuild-browser:dev":"esbuild src/browser.ts --bundle --outfile=dist/esbuild/browser.js","esbuild-browser:watch":"esbuild src/browser.ts --bundle --watch --outfile=dist/esbuild/browser.js","esbuild-node":"esbuild src/cli.ts --bundle --platform=node --minify --sourcemap=external --outfile=dist/esbuild/cli.js","esbuild-node:dev":"esbuild src/cli.ts --bundle --sourcemap=external --outfile=dist/esbuild/cli.js","esbuild-node:watch":"esbuild src/cli.ts --bundle --watch --sourcemap=external --outfile=dist/esbuild/cli.js"},"devDependencies":{"@types/jest":"^26.0.21","@types/node":"^15.0.1","@typescript-eslint/eslint-plugin":"^4.19.0","@typescript-eslint/parser":"^4.19.0","esbuild":"^0.11.11","eslint":"^7.22.0","jest":"^26.6.3","ts-jest":"^26.5.4","ts-node":"^9.1.1","typedoc":"^0.20.35","typescript":"^4.2.3"},"dependencies":{"bignumber.js":"^9.0.1","jstat":"^1.9.5","lodash":"^4.17.21"},"gitHead":"e4147c4947d3aba2a7c4ec0b78aca7072d19867b","bugs":{"url":"https://github.com/Alexintosh/AssetAllocator.js/issues"},"homepage":"https://github.com/Alexintosh/AssetAllocator.js#readme","_id":"@alexintosh/assetallocator@0.0.1","_nodeVersion":"15.9.0","_npmVersion":"7.5.3","dist":{"integrity":"sha512-UlN5lw5dHFqqttv0+klDAywHtdbmZiCD4OfkOBXyTDnBrLUF0xNOwwCYslBXM9s6lDg5D5y9l28ywtQFyMteXg==","shasum":"8d37233c0d8cef011d2a4617893c052d5469c840","tarball":"https://registry.npmjs.org/@alexintosh/assetallocator/-/assetallocator-0.0.1.tgz","fileCount":25,"unpackedSize":1222646,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhxI7VCRA9TVsSAnZWagAACWsP/0fW0HHSMMp/tbyA1qHI\nGgCwlZQzCdDtbWkhkT5SFGwELpXWc7unP/L2DNqUW6NPxOW8nXfBINCUtd0M\nFi/wvGft5I6JWO1uHondEDPNVDNe2eOB30HSJ/zkzPEbCVjHmLBoPw0Hk0Ez\nIDwX9s3pYhqdsTx+AHntHFJRiVjIBV8ywMecVRQWY1+enpwE2euyraDsjKWn\niNMr6iIrRsz1ZzNNd+zJQGiPjQwNu5s+Pd4F/yBO/8NsVDTaBnDEMODcmxiD\nH/x2KVxIg/ZQiJThSSn5nc71Q7/GHyqxBaWWB8UPO5X7wZQajEbACiJ60dTS\n45JfUMVNhz2yHH8aQqdyqb5In1sn97iMA7FeglgTztVeNKwLA1niwsjL1Gpd\nqhYsUuz6un0WCyc86IXI392j7IsUPWlAkJH20D/3SnLB1suDNmH/tjsFDQOB\nC5jkkHi4Fo5i0RUaj4fFzmO+sEK8LhxspMOKQmulBCswRaSi9IsMZvKy9mCc\nDxjIlmJpX53VXDJ1QwCZgJ8fU7tUEVzTsrCYbDR3SJXAIK/7Q9ijHg+qmQja\nor5/C805BjXKwXWnWnk/I13ND3Sdkwx/5S/ln9IJkQMBHLyOsDOC//8+1DAu\nDmiRygnUK1rRN7c6Rd+PCnfxnvVpw0Pgyd/3I3nO1MTGOu/pJZ+9yrEtETqh\nKoyx\r\n=gzBb\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDmYR4+kZP3wkYYcHBb7xmw7zlUGZNRDOtdma8V+holiAIgTRqgepEeCKsdoawRKjH5WK/mEySEnkylXnrtvcFsCqU="}]},"_npmUser":{"name":"alexintosh","email":"alessio.d@gmail.com"},"directories":{},"maintainers":[{"name":"alexintosh","email":"alessio.d@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assetallocator_0.0.1_1634141702305_0.5128687938087586"},"_hasShrinkwrap":false}},"time":{"created":"2021-10-13T16:15:02.245Z","0.0.1":"2021-10-13T16:15:02.687Z","modified":"2022-04-04T12:40:14.229Z"},"maintainers":[{"name":"alexintosh","email":"alessio.d@gmail.com"}],"description":"Creates allocation of crypto coins based on market data","homepage":"https://github.com/Alexintosh/AssetAllocator.js#readme","keywords":["defi","piedao","assets"],"repository":{"type":"git","url":"git+https://github.com/Alexintosh/AssetAllocator.js.git"},"author":{"name":"Alessio Delmonti","email":"alessio.d@gmail.com"},"bugs":{"url":"https://github.com/Alexintosh/AssetAllocator.js/issues"},"license":"MIT","readme":"# TypeScript Boilerplate for 2021\n\n[![Build and test status](https://github.com/metachris/typescript-boilerplate/workflows/Lint%20and%20test/badge.svg)](https://github.com/metachris/typescript-boilerplate/actions?query=workflow%3A%22Build+and+test%22)\n\nTypeScript project boilerplate with modern tooling, for Node.js programs, libraries and browser modules. Get started quickly and right-footed 🚀\n\n* [TypeScript 4](https://www.typescriptlang.org/)\n* Optionally [esbuild](https://esbuild.github.io/) to bundle for browsers (and Node.js)\n* Linting with [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint) ([tslint](https://palantir.github.io/tslint/) is deprecated)\n* Testing with [Jest](https://jestjs.io/docs/getting-started) (and [ts-jest](https://www.npmjs.com/package/ts-jest))\n* Publishing to npm\n* Continuous integration ([GitHub Actions](https://docs.github.com/en/actions) / [GitLab CI](https://docs.gitlab.com/ee/ci/))\n* Automatic API documentation with [TypeDoc](https://typedoc.org/guides/doccomments/)\n\nSee also the introduction blog post: **[Starting a TypeScript Project in 2021](https://www.metachris.com/2021/03/bootstrapping-a-typescript-node.js-project/)**.\n\n\n## Getting Started\n\n```bash\n# Clone the repository (you can also click \"Use this template\")\ngit clone https://github.com/metachris/typescript-boilerplate.git your_project_name\ncd your_project_name\n\n# Edit `package.json` and `tsconfig.json` to your liking\n...\n\n# Install dependencies\nyarn install\n\n# Now you can run various yarn commands:\nyarn cli\nyarn lint\nyarn test\nyarn build-all\nyarn ts-node <filename>\nyarn esbuild-browser\n...\n```\n\n* Take a look at all the scripts in [`package.json`](https://github.com/metachris/typescript-boilerplate/blob/master/package.json)\n* For publishing to npm, use `yarn publish` (or `npm publish`)\n\n## esbuild\n\n[esbuild](https://esbuild.github.io/) is an extremely fast bundler that supports a [large part of the TypeScript syntax](https://esbuild.github.io/content-types/#typescript). This project uses it to bundle for browsers (and Node.js if you want).\n\n```bash\n# Build for browsers\nyarn esbuild-browser:dev\nyarn esbuild-browser:watch\n\n# Build the cli for node\nyarn esbuild-node:dev\nyarn esbuild-node:watch\n```\n\nYou can generate a full clean build with `yarn build-all` (which uses both `tsc` and `esbuild`).\n\n* `package.json` includes `scripts` for various esbuild commands: [see here](https://github.com/metachris/typescript-boilerplate/blob/master/package.json#L23)\n* `esbuild` has a `--global-name=xyz` flag, to store the exports from the entry point in a global variable. See also the [esbuild \"Global name\" docs](https://esbuild.github.io/api/#global-name).\n* Read more about the esbuild setup [here](https://www.metachris.com/2021/04/starting-a-typescript-project-in-2021/#esbuild).\n* esbuild for the browser uses the IIFE (immediately-invoked function expression) format, which executes the bundled code on load (see also https://github.com/evanw/esbuild/issues/29)\n\n\n## Tests with Jest\n\nYou can write [Jest tests](https://jestjs.io/docs/getting-started) [like this](https://github.com/metachris/typescript-boilerplate/blob/master/src/main.test.ts):\n\n```typescript\nimport { greet } from './main'\n\ntest('the data is peanut butter', () => {\n  expect(1).toBe(1)\n});\n\ntest('greeting', () => {\n  expect(greet('Foo')).toBe('Hello Foo')\n});\n```\n\nRun the tests with `yarn test`, no separate compile step is necessary.\n\n* See also the [Jest documentation](https://jestjs.io/docs/getting-started).\n* The tests can be automatically run in CI (GitHub Actions, GitLab CI): [`.github/workflows/lint-and-test.yml`](https://github.com/metachris/typescript-boilerplate/blob/master/.github/workflows/lint-and-test.yml), [`.gitlab-ci.yml`](https://github.com/metachris/typescript-boilerplate/blob/master/.gitlab-ci.yml)\n* Take a look at other modern test runners such as [ava](https://github.com/avajs/ava), [uvu](https://github.com/lukeed/uvu) and [tape](https://github.com/substack/tape)\n\n## Documentation, published with CI\n\nYou can auto-generate API documentation from the TyoeScript source files using [TypeDoc](https://typedoc.org/guides/doccomments/). The generated documentation can be published to GitHub / GitLab pages through the CI.\n\nGenerate the documentation, using `src/main.ts` as entrypoint (configured in package.json):\n\n```bash\nyarn docs\n```\n\nThe resulting HTML is saved in `docs/`.\n\nYou can publish the documentation through CI:\n* [GitHub pages](https://pages.github.com/): See [`.github/workflows/deploy-gh-pages.yml`](https://github.com/metachris/typescript-boilerplate/blob/master/.github/workflows/deploy-gh-pages.yml)\n* [GitLab pages](https://docs.gitlab.com/ee/user/project/pages/): [`.gitlab-ci.yml`](https://github.com/metachris/typescript-boilerplate/blob/master/.gitlab-ci.yml)\n\nThis is the documentation for this boilerplate project: https://metachris.github.io/typescript-boilerplate/\n\n## References\n\n* **[Blog post: Starting a TypeScript Project in 2021](https://www.metachris.com/2021/03/bootstrapping-a-typescript-node.js-project/)**\n* [TypeScript Handbook](https://www.typescriptlang.org/docs/handbook/intro.html)\n* [tsconfig docs](https://www.typescriptlang.org/tsconfig)\n* [esbuild docs](https://esbuild.github.io/)\n* [typescript-eslint docs](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/README.md)\n* [Jest docs](https://jestjs.io/docs/getting-started)\n* [GitHub Actions](https://docs.github.com/en/actions), [GitLab CI](https://docs.gitlab.com/ee/ci/)\n\n\n## Feedback\n\nReach out with feedback and ideas:\n\n* [twitter.com/metachris](https://twitter.com/metachris)\n* [Create a new issue](https://github.com/metachris/typescript-boilerplate/issues)\n","readmeFilename":"README.md"}