{"_id":"@calvear/demo-env","_rev":"3-85e8921d5f35e964128fdc1a3e0e646e","name":"@calvear/demo-env","dist-tags":{"latest":"0.0.3"},"versions":{"0.0.1":{"version":"0.0.1","project":"common","name":"@calvear/demo-env","title":"Environment Variables CLI Tool","description":"Extensible environment variables handler for NodeJS apps","author":{"name":"Alvear Candia, Cristopher Alejandro","email":"calvear93@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/calvear93/env.git"},"license":"MIT","private":false,"keywords":["env","node","cli","typescript"],"scripts":{"build":"tsc --p tsconfig.build.json","pub":"npm run build && npm login && cd dist && npm publish --access public","lint":"eslint --ext .ts src/","lint:fix":"eslint --fix --ext .ts, src/","test":"jest --watchAll=false --verbose","prebuild":"rimraf dist/**","postbuild":"copyfiles package.json README.md LICENSE.md CHANGELOG.md assets/* dist"},"dependencies":{"ajv":"^8.10.0","ajv-formats":"^2.1.1","merge-deep":"^3.0.3","subslate":"^1.0.0","to-json-schema":"^0.2.5","tslog":"^3.3.2","yargs":"^17.3.1"},"devDependencies":{"@types/jest":"^27.4.1","@types/merge-deep":"^3.0.0","@types/node":"^17.0.21","@types/to-json-schema":"^0.2.1","@typescript-eslint/eslint-plugin":"^5.12.1","@typescript-eslint/parser":"^5.12.1","copyfiles":"^2.4.1","eslint":"^8.9.0","eslint-config-prettier":"^8.4.0","eslint-plugin-eslint-comments":"^3.2.0","eslint-plugin-jest":"^26.1.1","eslint-plugin-jest-formatting":"^3.1.0","eslint-plugin-prettier":"^4.0.0","eslint-plugin-promise":"^6.0.0","eslint-plugin-sonarjs":"^0.12.0","eslint-plugin-unicorn":"^41.0.0","jest":"^27.5.1","ts-jest":"^27.1.3","typescript":"^4.5.5"},"main":"index.js","types":"index.d.ts","bin":{"env":"main.js"},"engines":{"node":"~14.0.0 || ^16.14.2","npm":">=7.5.6"},"config":{"delimiters":{"template":["[[","]]"],"subcommand":[":",":"]},"parser":{"short-option-groups":true,"camel-case-expansion":false,"dot-notation":true,"parse-numbers":true,"boolean-negation":false}},"gitHead":"88a4272de2aff13dae65eff80aa58edce72621ab","bugs":{"url":"https://github.com/calvear93/env/issues"},"homepage":"https://github.com/calvear93/env#readme","_id":"@calvear/demo-env@0.0.1","_nodeVersion":"16.14.2","_npmVersion":"8.3.0","dist":{"integrity":"sha512-jMTUTXwlNgCf9eFo+1enWzmAf4yq/GX+JlMOjMnt7KCNZ/2+UN9J1tqR3zqiROkIlv6bCUJjXYniiY4Bu/npVw==","shasum":"6ccc93e9ceacbde3dc2ca4fb828199222ef93007","tarball":"https://registry.npmjs.org/@calvear/demo-env/-/demo-env-0.0.1.tgz","fileCount":96,"unpackedSize":431731,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiOHcRACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqTaQ/+LL2LJA9kja4TWJCLXXhd/Nw8fNEnmDexe+8Cn0u6i8tKRweG\r\n2Zo0r973rsjqzvEzG7XHuYKPnALuyYxBeEE4+E85k4rK3q41+gcz3hCAYGHM\r\nf3voOhaaV56/toSpSFPn1FQWsktdLhN50CREiZJP0k08/UOukt4hOHtFvRzm\r\nkwzyjbJU1sD/dBEUxeqah0zPs0Ds7BAVIMZuDRWOm60OVxVUqakAy7Q98T2i\r\nE3SFbLllK/SV7fzL8f+N8FmTKIClDRcdJWLXPan5HOFN/5Ojm+R/reaXPre4\r\nSkRmkRZHpxhmmRABExgKzkm1hBcbK/XOwY63GXNp0Y26y5E8hT9Qezq/G619\r\n7WX2GKzBITf0NXTiXNQojCJuA5Lk5W49zrQi0khJEYWyc7L3zB/lzCMQfKVC\r\nXi6e1o41PsF3AX9u9t/30Bam3KtAu6ufwpb08c03Oyxbm93GYCNzFkzFiiaY\r\nS9bdhFCucBCP0U2bODKdGrdqBN2zAd3gLLThLO3HsRm8xVm4tAoZ4jIJS2C3\r\nNa7tXFuHMQ42AwLSeJpO9t/CI/E91Z+csVwtwLMBQCT90CTBXDIUmU8l9jVq\r\n3W/Nk4Whs5WJYi1aTZBSRZJUf25K4h0YjzRaqkMCitLyV/pfZz9ruFW4Y7Zt\r\nKdlb6FS1EkNzl/Z3YJ0cXDhBUUX1qlnILCY=\r\n=m3jx\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGE5EAGAk4Ihj66Nh9XSD1GodTR9RK2/df0LklPL9G7+AiAPOtaXRqOM0aDoVROQoEOnN9fQ9j6A2hNyLYbGBoJuUg=="}]},"_npmUser":{"name":"calvear","email":"calvear93@gmail.com"},"directories":{},"maintainers":[{"name":"calvear","email":"calvear93@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/demo-env_0.0.1_1647867665438_0.2714415255528717"},"_hasShrinkwrap":false},"0.0.2":{"version":"0.0.2","project":"common","name":"@calvear/demo-env","title":"Environment Variables CLI Tool","description":"Extensible environment variables handler for NodeJS apps","author":{"name":"Alvear Candia, Cristopher Alejandro","email":"calvear93@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/calvear93/env.git"},"license":"MIT","private":false,"keywords":["env","node","cli","typescript"],"scripts":{"build":"tsc --p tsconfig.build.json","pub":"npm run build && npm login && cd dist && npm publish --access public","lint":"eslint --ext .ts src/","lint:fix":"eslint --fix --ext .ts, src/","test":"jest --watchAll=false --verbose","prebuild":"rimraf dist/**","postbuild":"copyfiles package.json README.md LICENSE.md CHANGELOG.md assets/* dist"},"dependencies":{"ajv":"^8.10.0","ajv-formats":"^2.1.1","merge-deep":"^3.0.3","subslate":"^1.0.0","to-json-schema":"^0.2.5","tslog":"^3.3.2","yargs":"^17.3.1"},"devDependencies":{"@types/jest":"^27.4.1","@types/merge-deep":"^3.0.0","@types/node":"^17.0.21","@types/to-json-schema":"^0.2.1","@typescript-eslint/eslint-plugin":"^5.12.1","@typescript-eslint/parser":"^5.12.1","copyfiles":"^2.4.1","eslint":"^8.9.0","eslint-config-prettier":"^8.4.0","eslint-plugin-eslint-comments":"^3.2.0","eslint-plugin-jest":"^26.1.1","eslint-plugin-jest-formatting":"^3.1.0","eslint-plugin-prettier":"^4.0.0","eslint-plugin-promise":"^6.0.0","eslint-plugin-sonarjs":"^0.12.0","eslint-plugin-unicorn":"^41.0.0","jest":"^27.5.1","ts-jest":"^27.1.3","typescript":"^4.5.5"},"main":"index.js","types":"index.d.ts","bin":{"env":"main.js"},"engines":{"node":"~14.0.0 || ^16.14.2","npm":">=7.5.6"},"config":{"delimiters":{"template":["[[","]]"],"subcommand":[":",":"]},"parser":{"short-option-groups":true,"camel-case-expansion":false,"dot-notation":true,"parse-numbers":true,"boolean-negation":false}},"gitHead":"88a4272de2aff13dae65eff80aa58edce72621ab","bugs":{"url":"https://github.com/calvear93/env/issues"},"homepage":"https://github.com/calvear93/env#readme","_id":"@calvear/demo-env@0.0.2","_nodeVersion":"16.14.2","_npmVersion":"8.3.0","dist":{"integrity":"sha512-/Wksd7zvFtTGG7FTFTBW5JZCWbKj+9lwC2wLwcmX+hCiuCY8OoRvOCPXwlTHTknZn0bFakSqlBbVo/aCJraPiQ==","shasum":"9ee863ccc1451b18828de20d459fcb2f280d025c","tarball":"https://registry.npmjs.org/@calvear/demo-env/-/demo-env-0.0.2.tgz","fileCount":96,"unpackedSize":435342,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiOHimACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmomCw//Y4moxBQ51jwh4Shi4KYH0E3biTB5/bb9m2V+6HGC2MeY87Vr\r\nUp5LcOgYk+Utak+6+bFfOE37bhomMdet1KjFrdzsm24ypXxh+gMlH/bPPkbf\r\nDAA1bnOVcNuSAwj1vygcaogUy2UDlA/pJhtQdc+ECEuDUitRVsTTnzImKsYJ\r\nJwjssl6VVMq2xbk0kfe6dzSQq/S28eEZP0zcK09e7LkPJX4pMX30bR1fsGhM\r\nx+g0Z3eI6LInzecmWxooiEM3B0UOpudWrV4y4bWmaGb9wXkh9Qmd059N7lZM\r\nUFtp3SVgmKKnbUgTY8VyX74cSOhn77gWABjt79Sr/HLbMoDVb7rZ/z1uChKA\r\nNOxtd1uPjGEjvLqk6C335MMgia+8Qdvwl/1LmIJhDZKEUnPvtxtXn8OFNakH\r\noPOJpJjbaJp7fN7EEnp/rLq4AViedxOb6D13EypW9Q2P72sKtkLr+suFywz6\r\n6ITy2Op5w///vQnrsp+OAXVInuxy0PHF4rJSyWmNg+fOa76peSRjqJz1bAQy\r\n0o2IVb2nbm55QRc6wjsYDDQButJaa5G51SLYCAC0LPclePXluzYUoKaBHZLi\r\nWM1up2hQ8pbAheqJfmYfW/V/1tQrJ9YbvBOWZyayr04J3OOBTyBr1P9lHa+s\r\n7IX/q7L/kZL4UAKhhIa43/N+n/UNHHfkfJg=\r\n=OrlG\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCLqAiTZJyxZGw9z+39y5Lh1x8HsVrCRmXovp4P3Eea6QIhAJFLlE6Q0E5NQ11L1o9AP/zZl1317cKDYSEjg4GZeYqQ"}]},"_npmUser":{"name":"calvear","email":"calvear93@gmail.com"},"directories":{},"maintainers":[{"name":"calvear","email":"calvear93@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/demo-env_0.0.2_1647868070752_0.5534669431188401"},"_hasShrinkwrap":false},"0.0.3":{"version":"0.0.3","project":"common","name":"@calvear/demo-env","title":"Environment Variables CLI Tool","description":"Extensible environment variables handler for NodeJS apps","author":{"name":"Alvear Candia, Cristopher Alejandro","email":"calvear93@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/calvear93/env.git"},"license":"MIT","private":false,"keywords":["env","node","cli","typescript"],"scripts":{"build":"tsc --p tsconfig.build.json","pub":"npm run build && npm login && cd dist && npm publish --access public","lint":"eslint --ext .ts src/","lint:fix":"eslint --fix --ext .ts, src/","test":"jest --watchAll=false --verbose","prebuild":"rimraf dist/**","postbuild":"copyfiles package.json README.md LICENSE.md CHANGELOG.md assets/* dist"},"dependencies":{"ajv":"^8.10.0","ajv-formats":"^2.1.1","chalk":"^4.1.2","merge-deep":"^3.0.3","subslate":"^1.0.0","to-json-schema":"^0.2.5","tslog":"^3.3.2","yargs":"^17.3.1"},"devDependencies":{"@types/jest":"^27.4.1","@types/merge-deep":"^3.0.0","@types/node":"^17.0.21","@types/to-json-schema":"^0.2.1","@typescript-eslint/eslint-plugin":"^5.12.1","@typescript-eslint/parser":"^5.12.1","copyfiles":"^2.4.1","eslint":"^8.9.0","eslint-config-prettier":"^8.4.0","eslint-plugin-eslint-comments":"^3.2.0","eslint-plugin-jest":"^26.1.1","eslint-plugin-jest-formatting":"^3.1.0","eslint-plugin-prettier":"^4.0.0","eslint-plugin-promise":"^6.0.0","eslint-plugin-sonarjs":"^0.12.0","eslint-plugin-unicorn":"^41.0.0","jest":"^27.5.1","ts-jest":"^27.1.3","typescript":"^4.5.5"},"main":"index.js","types":"index.d.ts","bin":{"env":"main.js"},"engines":{"node":"~14.0.0 || ^16.14.2","npm":">=7.5.6"},"config":{"delimiters":{"template":["[[","]]"],"subcommand":[":",":"]},"parser":{"short-option-groups":true,"camel-case-expansion":false,"dot-notation":true,"parse-numbers":true,"boolean-negation":false}},"gitHead":"a04ee193ea0290056a8d08a10bfc6c2ce91b2c79","bugs":{"url":"https://github.com/calvear93/env/issues"},"homepage":"https://github.com/calvear93/env#readme","_id":"@calvear/demo-env@0.0.3","_nodeVersion":"16.14.2","_npmVersion":"8.3.0","dist":{"integrity":"sha512-D5dcgJAPNyEuUeuhdMI4Nt66LhJEYx13lF7i/mGLveJbeX0IhUnKYIBAayLGuruaZS3WmoLh+1ovkdPuK8tA1Q==","shasum":"e8e8991d8d2b88855274d3ea1645217e9464bf94","tarball":"https://registry.npmjs.org/@calvear/demo-env/-/demo-env-0.0.3.tgz","fileCount":96,"unpackedSize":435370,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiOHmOACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmovQQ/8Dk37UzGjclgBLHPsHgggCqv9r53Ey81oea3+5nwTCG1gtMtc\r\nAxGm+XE5Ym053jQQv2Q4s1S9nKfWM4cSa3pzdWnSEUYVW8/lD9WQ6rOVnEUo\r\nMdEmD8x5aoipyAH9wQW8FNuDo9XaH/67Hu+11qs5RTBjkYmk6MKqOTO5kHlo\r\niCgECx+HjHzFFxiGOilDsFpCll/Izunt+g3titzvf/6+ARlo0G9CmMxHLWsm\r\n5UhpIaRWf0qaMxpITBIoDX3O9J06Mu0t+T0T/2HMS7ZfNcXBFuA7accgVH8c\r\n+KVszn/fxL0Aa5is6Z8xHWf+hOGc+gwCIwaR3RI7W/zJXLa++C/b+zrl55HZ\r\nvgQZkGWVH+gMk0UV/ZR2m0Qnd4IYeQ2vr4Z5oKsHn+aH7ERiqmI4ZP2SZK0g\r\n/OaI4LJtY2aODWJy/xNB1yn8Ky+8ibbp3gwMoScUKbLDYA3Hrg18utU6dEOq\r\ncaWJZ9KZ5lI9kKVWvhOn5F0leabbHmKUOcwtAEOD4Q0Atv8q9eKO+wmpywMQ\r\njIjRZpdNDwnXw0OYjOe6EYSL+/DhP6ntwaTZ1WDpPyVjjTfFD7EUwtNqR2Nq\r\nFNlLHnCPDwu6g99kmMtnQg4HNuh78u3ezp0qiNSbe77F2UnWjRRLwm36Uwt9\r\nzsnp8n/8gpodW/sqvJAMZSmEvmWqxdgJkI4=\r\n=PNoQ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEmnnYZ0VvzJPRAi9Ohgu/2xCHWP2yJB4A2WSfvBZQZbAiEAxXvkVedKGUwcQCMGkUvneLl9x2bL3Bk+lCJRXBTbDv8="}]},"_npmUser":{"name":"calvear","email":"calvear93@gmail.com"},"directories":{},"maintainers":[{"name":"calvear","email":"calvear93@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/demo-env_0.0.3_1647868302607_0.2436411119298718"},"_hasShrinkwrap":false}},"time":{"created":"2022-03-21T13:01:05.356Z","0.0.1":"2022-03-21T13:01:05.917Z","modified":"2022-04-04T21:33:31.251Z","0.0.2":"2022-03-21T13:07:50.964Z","0.0.3":"2022-03-21T13:11:42.859Z"},"maintainers":[{"name":"calvear","email":"calvear93@gmail.com"}],"description":"Extensible environment variables handler for NodeJS apps","homepage":"https://github.com/calvear93/env#readme","keywords":["env","node","cli","typescript"],"repository":{"type":"git","url":"git+https://github.com/calvear93/env.git"},"author":{"name":"Alvear Candia, Cristopher Alejandro","email":"calvear93@gmail.com"},"bugs":{"url":"https://github.com/calvear93/env/issues"},"license":"MIT","readme":"<h2 align=\"center\">\r\n  <img alt=\"logo\" src=\"assets/logo.png\" width=\"256px\"/>\r\n  <br/>\r\n  <strong styles=\"with=800px\">env</strong>\r\n</h2>\r\n\r\n<h3 align=\"center\">\r\n  ¡Environment variables handler made easy!\r\n</h3>\r\n\r\n<br />\r\n\r\n<p align=\"center\">\r\n  <img\r\n    src=\"https://img.shields.io/badge/version-1.0.0-blue?style=flat-square\"\r\n    alt=\"version\"\r\n  />\r\n  &nbsp;\r\n  <img\r\n    src=\"https://img.shields.io/badge/TypeScript-007ACC?style=flat-square&logo=typescript&logoColor=white\"\r\n    alt=\"typescript\"\r\n  />\r\n  &nbsp;\r\n  <img\r\n    src=\"https://img.shields.io/badge/nodejs-~14.0.0_||_^16.14.2-darkgreen?style=flat-square\"\r\n    alt=\"nodejs engine\"\r\n  />\r\n  &nbsp;\r\n  <img\r\n    src=\"https://img.shields.io/badge/npm->=7.5.6-darkgreen?style=flat-square\"\r\n    alt=\"npm engine\"\r\n  />\r\n  &nbsp;\r\n  <img\r\n    src=\"https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square\"\r\n    alt=\"license\"\r\n  />\r\n</p>\r\n\r\n<br />\r\n\r\n<!-- TABLE OF CONTENTS -->\r\n<details>\r\n  <summary>Table of Contents</summary>\r\n  <ol>\r\n    <li>\r\n      <a href=\"#about-the-project\">About The Project</a>\r\n      <ul>\r\n        <li><a href=\"#built-with\">Built With</a></li>\r\n      </ul>\r\n    </li>\r\n    <li>\r\n      <a href=\"#getting-started\">Getting Started</a>\r\n      <ul>\r\n        <li><a href=\"#prerequisites\">Prerequisites</a></li>\r\n        <li><a href=\"#installation\">Installation</a></li>\r\n      </ul>\r\n    </li>\r\n    <li><a href=\"#usage\">Usage</a></li>\r\n    <li><a href=\"#roadmap\">Roadmap</a></li>\r\n    <li><a href=\"#contributing\">Contributing</a></li>\r\n    <li><a href=\"#license\">License</a></li>\r\n    <li><a href=\"#contact\">Contact</a></li>\r\n    <li><a href=\"#acknowledgments\">Acknowledgments</a></li>\r\n  </ol>\r\n</details>\r\n\r\n<br />\r\n\r\n<!-- ABOUT THE PROJECT -->\r\n\r\n## 📖 About\r\n\r\nThe aim of this library is ease NodeJS <b>environment variable handling</b>, like [env-cmd](https://www.npmjs.com/package/env-cmd) or [dotenv](https://www.npmjs.com/package/dotenv), but with <b>powerfull features and extensibility</b> for adding custom providers (as plugins) for <u>load</u>, <u>pull</u> and <u>push</u> the variables from different stores.\r\n\r\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\r\n\r\n## ⚡️ Quick start\r\n\r\n```bash\r\nnpm install @calvear/env\r\n```\r\n\r\n> 🔔 Make sure that you have [NodeJS 14+](https://nodejs.org/) installed on your computer.\r\n\r\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\r\n\r\n## 📌 Requirements\r\n\r\nFirst, [download](https://nodejs.org/) and install **NodeJS**. Version `14` or higher is required.\r\n\r\nValidate installed versions of node and npm with:\r\n\r\n```bash\r\n> node -v\r\nv16.14.2\r\n\r\n> npm -v\r\n8.3.0\r\n```\r\n\r\nYou can initialize a new npm project using:\r\n\r\n```bash\r\n> npm init\r\n```\r\n\r\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\r\n\r\n## ⚙️ Commands & Options\r\n\r\n### **[>_] `env`**\r\n\r\nLoad your environment variables into a subcommand.\r\n\r\n```bash\r\nenv [OPTION]\r\n```\r\n\r\n| Option | Description | Type   | Default | Required? |\r\n| ------ | ----------- | ------ | ------- | --------- |\r\n| `-t`   | dem.        | `bool` | `false` | No        |\r\n\r\n### `deploy`\r\n\r\nCLI command for deploy Docker containers with your project via Ansible to the remote server.\r\n\r\n```bash\r\nts deploy [OPTION]\r\n```\r\n\r\n| Option | Description                                                                                            | Type   | Default | Required? |\r\n| ------ | ------------------------------------------------------------------------------------------------------ | ------ | ------- | --------- |\r\n| `-k`   | Prompt you to provide the remote user sudo password (_a standard Ansible `--ask-become-pass` option_). | `bool` | `false` | No        |\r\n\r\n### Built With\r\n\r\n-   [yargs](http://yargs.js.org/)\r\n-   [tslog](https://tslog.js.org/#/)\r\n-   [subslate](https://github.com/josh-hemphill/subslate)\r\n-   [merge-deep](https://github.com/jonschlinkert/merge-deep)\r\n-   [ajv](https://ajv.js.org/)\r\n-   [to-json-schema](https://www.npmjs.com/package/to-json-schema)\r\n\r\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\r\n\r\n<!-- GETTING STARTED -->\r\n\r\n## Getting Started\r\n\r\nThis is an example of how you may give instructions on setting up your project locally.\r\nTo get a local copy up and running follow these simple example steps.\r\n\r\n### Prerequisites\r\n\r\nThis is an example of how to list things you need to use the software and how to install them.\r\n\r\n-   npm\r\n    ```sh\r\n    npm install npm@latest -g\r\n    ```\r\n\r\n### Installation\r\n\r\n1. Get a free API Key at [https://example.com](https://example.com)\r\n2. Clone the repo\r\n    ```sh\r\n    git clone https://github.com/github_username/repo_name.git\r\n    ```\r\n3. Install NPM packages\r\n    ```sh\r\n    npm install\r\n    ```\r\n4. Enter your API in `config.js`\r\n    ```js\r\n    const API_KEY = 'ENTER YOUR API';\r\n    ```\r\n\r\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\r\n\r\n<!-- USAGE EXAMPLES -->\r\n\r\n## Usage\r\n\r\nUse this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.\r\n\r\n_For more examples, please refer to the [Documentation](https://example.com)_\r\n\r\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\r\n\r\n<!-- ROADMAP -->\r\n\r\n## Roadmap\r\n\r\n-   [ ] Feature 1\r\n-   [ ] Feature 2\r\n-   [ ] Feature 3\r\n    -   [ ] Nested Feature\r\n\r\nSee the [open issues](https://github.com/github_username/repo_name/issues) for a full list of proposed features (and known issues).\r\n\r\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\r\n\r\n<!-- LICENSE -->\r\n\r\n## License\r\n\r\nDistributed under the MIT License. See `LICENSE.txt` for more information.\r\n\r\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\r\n","readmeFilename":"README.md"}