{"_id":"@alex.gracia/aspen","name":"@alex.gracia/aspen","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@alex.gracia/aspen","version":"0.0.1","author":{"name":"Monax"},"repository":{"type":"git","url":"git+ssh://git@github.com/monax/aspen-publishing-sdk.git"},"license":"UNLICENSED","packageManager":"yarn@3.2.1","workspaces":{"packages":["pkg/sdk","pkg/examples/react"]},"description":"TODO","bugs":{"url":"https://github.com/monax/aspen-publishing-sdk/issues"},"homepage":"https://github.com/monax/aspen-publishing-sdk#readme","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"gitHead":"027cb3e22d7aae2ee4b98503b70a661408308582","_id":"@alex.gracia/aspen@0.0.1","_nodeVersion":"16.16.0","_npmVersion":"8.11.0","dist":{"integrity":"sha512-4i8jOBTNyT72q62vug2dM/TN/jgt4+F3W6SgKXJMrrS/YBlVQrL1eJpwLWfu9relpYJbqh7MM7236iPfmaenBA==","shasum":"d664f05a03f4cfefe166185731427047251dfdb1","tarball":"https://registry.npmjs.org/@alex.gracia/aspen/-/aspen-0.0.1.tgz","fileCount":38,"unpackedSize":3143751,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDYN4fAA2aXFz6ygBgPn+BDBSaOiA7WvMEx2VqEJCRxHAiEAkaqx2pT9LC1QJliSHfflRUZebl919LdmDV37kVmZIHY="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjFYOEACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmry5w/+P9KYL8PQ+QSUkQdAJtoHYHpZSTthDweuXVO/bDHyKpL3gvpJ\r\ne5OTn36tQg7mLKpPgXTqbWnxwxWD6oiYay7FnodavYWPvkSXaSC5cR2saPNr\r\nyv8wi21YVViwJZ0QUz6TS5K4VR+4PYoDWpLROuX6jyWw36nMLFqk9yl0u6G6\r\nIs2+1tDfT6+rnWHAF9F7z+Yx+0Plv12zugOvJuoTgf+I5UH1ihdmZDA5hjJR\r\nJk49n4hP/9W3adlTSTOQqyG+i6YXlDmGbI8X+YhkKNTteGiQ6auXeUX4foBv\r\nPFkJgvDPAePCu3Qvl/uF1wvOySYLGK6KbghrRtsQWshA7n9Ya8xzLzvZ71HN\r\n4GePo7tVWa6vtphmn0fLum5emOYK9e35LIGWAaONCwrZDjMwquCovklfTz2k\r\nAYKQtB06CJxYwoG2W3LOI5QqsAZeQshLPvMubQSTNXejSGQK+xA6HBe21BH8\r\nl7cWhXeRXdVOfMyHu45xIcBD5QeDtAAbgLAysPTJ6IzUg3t6aMpCtId9lH/Y\r\nO85yBPX1bCw6JBDHuycWJCNo+SqmPRlR3hLJrv50ZXSjnyMz2q/k1VmRebK8\r\nL27E9Zqn+x51uNPV/d2UVpjMYO/H5MisiFRGVRg3niPoJbWh+aOHu/x45S8y\r\non2tcqNUWHW4/2BrUm9BOc11onP3agHZ7ig=\r\n=8Apy\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"alex.gracia","email":"alex.gracia.lupotto@monaxlabs.io"},"directories":{},"maintainers":[{"name":"alex.gracia","email":"alex.gracia.lupotto@monaxlabs.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/aspen_0.0.1_1662354308503_0.31271223997489117"},"_hasShrinkwrap":false}},"time":{"created":"2022-09-05T05:05:08.437Z","0.0.1":"2022-09-05T05:05:08.709Z","modified":"2022-09-05T05:05:08.871Z"},"maintainers":[{"name":"alex.gracia","email":"alex.gracia.lupotto@monaxlabs.io"}],"description":"TODO","homepage":"https://github.com/monax/aspen-publishing-sdk#readme","repository":{"type":"git","url":"git+ssh://git@github.com/monax/aspen-publishing-sdk.git"},"author":{"name":"Monax"},"bugs":{"url":"https://github.com/monax/aspen-publishing-sdk/issues"},"license":"UNLICENSED","readme":"# Aspen Publishing SDK\n\n**Aspen Publishing SDK** is a developer-friendly interface where developers/creators/clients can interact with Aspen's Publishing contracts out-of-the-box.\n\n## How it works\n\nAspen Publishing SDK's has a folder in `pkg/sdk/src/abi` where the `JSON abis` of the contracts are located. Once, the steps of the `Software Build` chapter are done.\nAny developer can use these contracts, to show how an app can be builded and how the contracts are used we provided with some examples in `pkg/examples`.\n\n## Software Build\n\n### Step 1: Get sources from Github\n\n```\n   $ git clone https://github.com/monax/aspen-publishing-sdk.git\n   $ cd aspen-publishing-sdk\n```\n\n### Step 2: Install dependencies\n\nAfter getting the sources, we install the general dependencies and we create the workspaces to allow the interaction between `pkgs`.\n\n```\n   $ yarn install\n```\n\n### Step 3: Generate Typescript contracts\n\nOnce is installed, we should go to the `pkg/sdk` and create the `types` files in `Typescript` from the contracts.\nDoing this process, will allow the developers/users to see the flow of generating them.\n\n```\n  $ cd sdk\n  $ yarn generate\n  $ yarn build\n  $ yarn prettier\n  $ yarn lint\n```\n\nNow it's all set to use it in any `Typescript` project. This contracts could work in any other languague using the right libraries.\n","readmeFilename":"README.md"}