{"_id":"@brainspore/celadon-base","_rev":"3-6631815270eb4feade3a57d67590cfb3","name":"@brainspore/celadon-base","description":"Student Portal Base Dashboard","dist-tags":{"latest":"2.0.1"},"versions":{"1.0.0":{"name":"@brainspore/celadon-base","version":"1.0.0","keywords":["Dashboard"],"author":{"name":"paullaster.okoth"},"license":"MIT","_id":"@brainspore/celadon-base@1.0.0","maintainers":[{"name":"paullaster","email":"paullasterokoth98@gmail.com"}],"dist":{"shasum":"92bcc0a180c1d7514598babca505dd2ad9916907","tarball":"https://registry.npmjs.org/@brainspore/celadon-base/-/celadon-base-1.0.0.tgz","fileCount":65,"integrity":"sha512-fgPdh80gLy8XpaxIAdSJ4nvw9j4TQPvcQAcwCtyYgI6D8FKwKkANX/G2a4HYkDl/vrE0NKKBmuVnk6cx5Hb4xQ==","signatures":[{"sig":"MEYCIQCHtkRaTm7WpaEWxGU5JQsHmk5LQy5xlAXOStcpcKVEwgIhAIeQtGcnitjp+Jmu9yxku6Zegv3kWkwARSymYW9wprjL","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":145925},"main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"paullaster","email":"paullasterokoth98@gmail.com"},"_npmVersion":"10.8.1","description":"Student Portal Base Dashboard","directories":{},"_nodeVersion":"21.6.2","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/celadon-base_1.0.0_1720260379931_0.152440207152716","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@brainspore/celadon-base","version":"1.0.1","keywords":["Dashboard"],"author":{"name":"paullaster.okoth"},"license":"MIT","_id":"@brainspore/celadon-base@1.0.1","maintainers":[{"name":"paullaster","email":"paullasterokoth98@gmail.com"}],"dist":{"shasum":"b3734e65fb11c3de92b39952847843e8fb7ee1bd","tarball":"https://registry.npmjs.org/@brainspore/celadon-base/-/celadon-base-1.0.1.tgz","fileCount":67,"integrity":"sha512-FPlriAo+5baTarKfTfQJl0VJy24SuFNl19OvaoRvRk/24kF4BeENtyFlsDdFZsPzvWWWpUsA+rhqHP7BHE9EmQ==","signatures":[{"sig":"MEYCIQD/2PpEcVgx29jGUS/WX/fR036d5EFn66TRY72G6bLjWQIhAKvTRy91hD9Qa+DzrWY6vIK8SxviJ2qJp5OTVVdtlE25","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":152101},"main":"index.js","gitHead":"527a41c17cece4833fc75903eeabe0297e1a897d","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"paullaster","email":"paullasterokoth98@gmail.com"},"_npmVersion":"10.8.1","description":"Student Portal Base Dashboard","directories":{},"_nodeVersion":"21.7.3","dependencies":{"@brainspore/celadon-base":"^1.0.0","@brainspore/celadon-profile":"^1.0.1"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/celadon-base_1.0.1_1720262556406_0.14995427644204984","host":"s3://npm-registry-packages"}},"1.1.3":{"name":"@brainspore/celadon-base","version":"1.1.3","keywords":["Dashboard"],"author":{"name":"paullaster.okoth"},"license":"MIT","_id":"@brainspore/celadon-base@1.1.3","maintainers":[{"name":"paullaster","email":"paullasterokoth98@gmail.com"}],"dist":{"shasum":"dc6352e0d17c6a0b9d56e786e747976f038c124f","tarball":"https://registry.npmjs.org/@brainspore/celadon-base/-/celadon-base-1.1.3.tgz","fileCount":81,"integrity":"sha512-3TN/BD2natGPI2CeYdaAE9KJkKef8DavJcBaqSEZIldvQi2kiO5uPtlF4R13i/8exky0m+K+vQVY0564fserXA==","signatures":[{"sig":"MEUCIQC1z7ISgsNugKjQ2BWltCkFmk3FxqzMzn54A1dFL+YYmQIgd/ZPLaXJHadFaKaPGotpuXWNrOoPzAiRD3PAl+hMsD0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":140119},"main":"index.js","gitHead":"1cad0d78e21dce4256630f78fdf6b198a3481f1a","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"paullaster","email":"paullasterokoth98@gmail.com"},"_npmVersion":"10.8.1","description":"Student Portal Base Dashboard","directories":{},"_nodeVersion":"21.7.3","dependencies":{"@brainspore/celadon-base":"^1.0.1","@brainspore/celadon-profile":"^1.3.4"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/celadon-base_1.1.3_1720263023093_0.24012989746331193","host":"s3://npm-registry-packages"}},"2.0.1":{"name":"@brainspore/celadon-base","version":"2.0.1","description":"Student Portal Base Dashboard","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"keywords":["Dashboard"],"author":{"name":"paullaster.okoth"},"license":"MIT","dependencies":{"@brainspore/celadon-base":"^1.1.3","@brainspore/celadon-profile":"^1.3.4"},"_id":"@brainspore/celadon-base@2.0.1","gitHead":"9bef1636730862de0be538b93005f64a181b7030","_nodeVersion":"21.7.3","_npmVersion":"10.8.1","dist":{"integrity":"sha512-n+pvZz1limdBMXbcA6TVnnhQVMujqgquVAR+0iAPH0eITFj0+reL7HFLUkFDv48IUN829LVUxZazYkpygFbf9Q==","shasum":"a3c0acd51136407e9431e297854d2e60d06a611e","tarball":"https://registry.npmjs.org/@brainspore/celadon-base/-/celadon-base-2.0.1.tgz","fileCount":95,"unpackedSize":2039234,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDaL6ikxzrzGJd7ej9LJz2jUObg4FgfOBOjQ25u4f/p7AiBCvMEuH7aeznOn/nnlmT32PRn0keYLWefJHCK3YXNphQ=="}]},"_npmUser":{"name":"paullaster","email":"paullasterokoth98@gmail.com"},"directories":{},"maintainers":[{"name":"paullaster","email":"paullasterokoth98@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/celadon-base_2.0.1_1720263358898_0.4027783884645153"},"_hasShrinkwrap":false}},"time":{"created":"2024-07-06T10:06:19.817Z","modified":"2024-07-06T10:55:59.392Z","1.0.0":"2024-07-06T10:06:20.073Z","1.0.1":"2024-07-06T10:42:36.633Z","1.1.3":"2024-07-06T10:50:23.262Z","2.0.1":"2024-07-06T10:55:59.140Z"},"maintainers":[{"name":"paullaster","email":"paullasterokoth98@gmail.com"}],"author":{"name":"paullaster.okoth"},"keywords":["Dashboard"],"license":"MIT","readme":"# Celadon\r\n## Student Portal base dashboard\r\n\r\n## Installation\r\n\r\n1. Create a new vue cli project\r\n ```\r\nvue create myproject\r\n```\r\n2. Install and initialize vuetify Material Design Framework\r\n ```\r\nvue add vuetify\r\n```\r\n3. Install cardinal base dashboard to your project\r\n ```\r\nnpm i @kinetics254/cardinal-base\r\n```\r\n4. Register plugin in your mani.js\r\n ```\r\nimport Vue from \"vue\";\r\nimport App from \"./App.vue\";\r\nimport cardinal from \"@kinetics254/sirius-base\";\r\n\r\nconst options = {\r\n  store,\r\n  router,\r\n};\r\n\r\nVue.use(cardinal, options ); //options to auto add register store and routes\r\n\r\nnew Vue({\r\n  router,\r\n  store,\r\n  vuetify,\r\n  render: (h) => h(App),\r\n}).$mount(\"#app\");\r\n```\r\n5. Set Environment Variables\r\n```\r\nVUE_APP_NAME='CARDINAL'\r\nVUE_APP_VERSION='v0.0.1'\r\nVUE_APP_URL='http://localhost:8080'\r\nVUE_APP_API_BASE_URL='http://localhost:8000/api/v1/'\r\nVUE_APP_SOCKET_URL='http://localhost:6001'\r\n```\r\n\r\n6. Enable Babel Optional chaining feature \r\n```\r\n// vue.config.js\r\nmodule.exports = {\r\n    chainWebpack: config => {\r\n        config.module\r\n            .rule('vue')\r\n            .use('vue-loader')\r\n            .tap(options => {\r\n                options.compiler = require('vue-template-babel-compiler')\r\n                return options\r\n            })\r\n    }\r\n}\r\n```\r\n7. Start your server\r\n```\r\nnpm run serve\r\n```\r\n\r\n\r\n## Modules\r\n```\r\n1. Landing module on root (http://domain:port)\r\n2. Auth module for \r\n    - Login (http://domain:port/auth)\r\n    - password reset (http://domain:port/auth/forgot-password)\r\n3. Dashboard module on (http://domain:port/dashboard)\r\n```\r\n\r\n## Services\r\n```\r\n1. http (axios);\r\n2. sockets (echo with socket io)\r\n```\r\n\r\n## Plugins\r\n```\r\n1. Confirmation Modal\r\n2. Loader\r\n```\r\n\r\n## Utilities\r\n```\r\n1. Filters (Date, Currency, Number, String)\r\n2. Helper (helper functions)\r\n```\r\n\r\n## mixins\r\n```\r\n1. File mixin (base64 file handling)\r\n2. Date mixin (formating dates)\r\n3. Router mixin (scrumble route params)\r\n```\r\n\r\n## Dependencies\r\n```\r\n\"dependencies\": {\r\n    \"epic-spinners\": \"^1.1.0\",\r\n    \"file-type\": \"^16.5.3\",\r\n    \"moment\": \"^2.29.1\",\r\n    \"vue\": \"^2.6.11\",\r\n    \"vue-router\": \"^3.2.0\",\r\n    \"vuetify\": \"^2.4.0\",\r\n    \"vuex\": \"^3.4.0\",\r\n    \"axios\": \"^0.24.0\",\r\n    \"lodash\": \"^4.17.21\",\r\n    \"laravel-echo\": \"^1.11.3\",\r\n    \"socket.io-client\": \"^2.4.0\",\r\n    \"vue-template-babel-compiler\": \"^1.0.7\",\r\n    \"vue-pdf\": \"^4.2.0\"\r\n  }\r\n```\r\n\r\n### Authors\r\n````\r\nMichael - michael.kamau@kinetics.co.ke\r\n````\r\n# **ヽ(•‿•)ノ Happy Coding!**\r\n","readmeFilename":"README.md"}