{"bugs":{"url":"https://github.com/Canner/vulcan-sql/issues"},"dist":{"shasum":"190ed5a0ebbc9d2badcc3094f97e19e53c57ea96","tarball":"https://registry.npmjs.org/@vulcan-sql/catalog-server/-/catalog-server-0.10.1-dev.20231017.0.tgz","fileCount":98,"integrity":"sha512-UK//MZGFSzKD4+zkSLmxUS/f9uDkpU9yHAX0c19lqretoYVfC1NyMHL1RgXLabCp0WUF+KJTIZd2BpjMILjWcw==","signatures":[{"sig":"MEYCIQDDAqBb4egyUF9rJZQjmj9dZAH7quaHJ0i4yxNvWRxYQwIhAPWogde9iWtWh7U7hFRTQaOXparQxrXE5tcJO2BEpjEJ","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":98343715},"name":"@vulcan-sql/catalog-server","readme":"# catalog-server\n\nThis package serves as a catalog page for VulcanSQL.\n\n## Install\n\n1. Install package\n\n    ```bash\n    npm i @vulcan-sql/catalog-server\n    ```\n\n2. Use [@vulcan-sql/cli](https://www.npmjs.com/package/@vulcan-sql/cli) to start the catalog server.\n<br/>(The VulcanSQL server needs to listen first.)\n\n    ```bash\n    vulcan catalog\n    ```\n\n3. Open in browser. By default, it is http://localhost:4200.\n\n\n## Running a Production\n\n1. Use [@vulcan-sql/cli](https://www.npmjs.com/package/@vulcan-sql/cli) to generate the catalog server assets.\n\n    Node.js:\n    ```bash\n      vulcan package -o node -t catalog-server\n    ```\n    Copy the files in the `./dist` folder to your production servers. Then run `npm install` && `node index.js` to start the server.\n\n    Docker:\n    ```bash\n      vulcan package -o docker -t catalog-server\n      docker build -t <tag> ./dist\n    ```\n\n\n## Configurations (optional)\n\nThese are some configurations related with catalog in `vulcan.yaml`.\n- The listen `port` can be change or just directly use `vulcan catalog -p 4200`.\n- The production packager `folderPath` also can be change if needed.\n\n```yaml\n# change the listen port\ncatalog:\n  port: 4200\n\n# change the production packager folder path\nnode-packager:\n  catalog-server:\n    folderPath: dist\ndocker-packager:\n  catalog-server:\n    folderPath: dist\n\n```\n\n","gitHead":"ab7411f873afb9c3e0e5ede14fb5321fd9cce659","license":"Apache-2.0","scripts":{"start":"next start"},"_npmUser":{"name":"cannerbot","email":"william@cannerdata.com"},"homepage":"https://github.com/Canner/vulcan-sql#readme","keywords":["vulcan","vulcan-sql","data","sql","database","data-warehouse","data-lake","api-builder","app"],"repository":{"url":"git+https://github.com/Canner/vulcan-sql.git","type":"git"},"_npmVersion":"8.15.1","description":"Catalog server for VulcanSQL","directories":{},"maintainers":[{"name":"fredalai","email":"fredalai00@gmail.com"},{"name":"shimin.wong","email":"andreashimin@gmail.com"},{"name":"star.you","email":"star2ver.dev@gmail.com"},{"name":"cannerbot","email":"william@cannerdata.com"},{"name":"eason.kuo","email":"v6610688@gmail.com"},{"name":"wwwy3y3","email":"wwwy3y3@gmail.com"}],"_nodeVersion":"16.16.0","dependencies":{"antd":"4.22.6","next":"12.1.5","uuid":"^9.0.0","axios":"^0.27.2","micro":"^9.4.1","react":"18.0.0","graphql":"^16.6.0","react-is":"18.0.0","react-dom":"18.0.0","@nrwl/next":"14.0.3","micro-cors":"^0.1.1","jsonwebtoken":"^8.5.1","@apollo/client":"^3.6.9","graphql-type-json":"^0.3.2","styled-components":"5.3.5","apollo-server-micro":"^3.10.2","next-plugin-antd-less":"^1.8.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"@testing-library/react":"13.1.1"},"_npmOperationalInternal":{"tmp":"tmp/catalog-server_0.10.1-dev.20231017.0_1697510471386_0.11735956565688199","host":"s3://npm-registry-packages"},"_id":"@vulcan-sql/catalog-server@0.10.1-dev.20231017.0","version":"0.10.1-dev.20231017.0"}