{"_id":"@autom8te/create-starter-templates","_rev":"4-98920ee297a7deefd672447c32138505","name":"@autom8te/create-starter-templates","dist-tags":{"latest":"0.0.4"},"versions":{"0.0.1":{"name":"@autom8te/create-starter-templates","version":"0.0.1","author":{"name":"autom8te"},"license":"MIT","_id":"@autom8te/create-starter-templates@0.0.1","maintainers":[{"name":"autom8te","email":"ericagnitsch.dev@gmail.com"}],"bin":{"create-starter-templates":"create-starter-templates.js"},"dist":{"shasum":"d4b354d70d3f0028a21d91c811332b9f52672d60","tarball":"https://registry.npmjs.org/@autom8te/create-starter-templates/-/create-starter-templates-0.0.1.tgz","fileCount":47,"integrity":"sha512-KgXGaVi79LEHID9zoJPsD+Tv9lbm7bz9ObWRsWT3frsGhj2IzEVu1CBA4WU1JnxNnXITEyA68q82lofrLrf9Xw==","signatures":[{"sig":"MEYCIQDUniPkEIY5H4Hbev7afCpYFN2IH1HOtjOUX0P4KyH6XQIhAJ5ALczjxYjUvdUlW4P4yTxzH/41N5Ge4ErPAHBwX5Jj","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":51033},"_npmUser":{"name":"autom8te","email":"ericagnitsch.dev@gmail.com"},"description":"Starter templates for creating NextJS or Express projects.","directories":{},"licenseText":"MIT License\n\nCopyright (c) 2024 Eric Agnitsch\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","dependencies":{"path":"^0.12.7","fs-extra":"^11.2.0","commander":"^12.1.0","handlebars":"^4.7.8"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/create-starter-templates_0.0.1_1718774031911_0.18660333360919057","host":"s3://npm-registry-packages"}},"0.0.2":{"name":"@autom8te/create-starter-templates","version":"0.0.2","author":{"name":"autom8te"},"license":"MIT","_id":"@autom8te/create-starter-templates@0.0.2","maintainers":[{"name":"autom8te","email":"ericagnitsch.dev@gmail.com"}],"bin":{"create-starter-templates":"create-starter-templates.js"},"dist":{"shasum":"8cf6e46a31df3445db154e1f03a85bacdc0265b2","tarball":"https://registry.npmjs.org/@autom8te/create-starter-templates/-/create-starter-templates-0.0.2.tgz","fileCount":64,"integrity":"sha512-WCJz8ca4o+tKlquwhNppEzu9CatIF/l2qG2FI9cdQ3YImoJk4fcHTuWlEo9Xyhmn14axe39jVOZZkg0LZ7sKkg==","signatures":[{"sig":"MEYCIQCB7k3u3Im3OlX4/8prEx10mJb7hWPdMIw7Bn4HWENrzgIhAP3H6+6ULEbwY4Q+kzTALhrYKCzVzWzok7VJyBby158c","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":58387},"_npmUser":{"name":"autom8te","email":"ericagnitsch.dev@gmail.com"},"description":"Starter templates for creating NextJS or Express projects.","directories":{},"licenseText":"MIT License\n\nCopyright (c) 2024 Eric Agnitsch\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","dependencies":{"path":"^0.12.7","fs-extra":"^11.2.0","commander":"^12.1.0","handlebars":"^4.7.8"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/create-starter-templates_0.0.2_1718865286328_0.7391095770859946","host":"s3://npm-registry-packages"}},"0.0.4":{"name":"@autom8te/create-starter-templates","author":{"name":"autom8te"},"version":"0.0.4","description":"Starter templates for creating NextJS or Express projects.","license":"MIT","bin":{"create-starter-templates":"create-starter-templates.js"},"dependencies":{"commander":"^12.1.0","fs-extra":"^11.2.0","handlebars":"^4.7.8","path":"^0.12.7"},"licenseText":"MIT License\n\nCopyright (c) 2024 Eric Agnitsch\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","_id":"@autom8te/create-starter-templates@0.0.4","dist":{"shasum":"c40e6952589fd7e6a0e97f2c68efe0764596fe8c","integrity":"sha512-ZwhNQap/xmFx5aFXvqiQ5VgnOjCPGop+VhRdX37OXaAT5w+q2WKRsGdrefYMnWnDVKze96zbrqQFbE/KAZudBA==","tarball":"https://registry.npmjs.org/@autom8te/create-starter-templates/-/create-starter-templates-0.0.4.tgz","fileCount":74,"unpackedSize":75698,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCmZ+5t0Dn/zTCBoNMlarHt3K1+HbdZJeUoqL6DNn0WrQIhAKYUaTwVGg9clfhpomhdsh30ZDN8gHL//93Dpq78pnLm"}]},"_npmUser":{"name":"autom8te","email":"ericagnitsch.dev@gmail.com"},"directories":{},"maintainers":[{"name":"autom8te","email":"ericagnitsch.dev@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/create-starter-templates_0.0.4_1724214316792_0.11309089705184538"},"_hasShrinkwrap":false}},"time":{"created":"2024-06-19T05:13:51.835Z","modified":"2024-08-21T04:25:17.180Z","0.0.1":"2024-06-19T05:13:52.078Z","0.0.2":"2024-06-20T06:34:46.508Z","0.0.3":"2024-08-20T03:41:05.394Z","0.0.4":"2024-08-21T04:25:16.983Z"},"author":{"name":"autom8te"},"license":"MIT","description":"Starter templates for creating NextJS or Express projects.","maintainers":[{"name":"autom8te","email":"ericagnitsch.dev@gmail.com"}],"readme":"# [create-starter-templates](https://github.com/EricAgnitsch/create-starter-templates)\n\n<p align=\"center\">Spin up a Next.js app/Express.js server in a single command.</p>\n\n### Templates\n\n#### Next.js\n\n- NextUI\n- yup\n- FontAwesome\n- Supabase\n- Docker\n\n#### Express.js\n\n- Supabase\n- Docker\n\n### Requirements\n\nBefore starting, ensure you have the following installed and configured:\n\n- **Node.js**: [Installation guide](https://nodejs.org/en/download/)\n- **Yarn**: Run `npm install --global yarn` to install Yarn via npm.\n- **Supabase**: A [Supabase](https://supabase.com/) project.\n- **Supabase CLI**: See [here](https://supabase.com/docs/reference/cli/introduction?queryGroups=example&example=supabase-init-basic-usage).\n\n### Getting Started\n\n#### Next.js\n\n- Create a new Next.js app with `npx @autom8te/create-starter-templates@latest -n <project_name> --nextjs`. Replace `project_name` with your camelCase project name\n- Navigate to new project folder\n- Run `yarn`\n- Run `yarn dev`\n- Go to `http://localhost:3000` in browser\n\n#### Express.js\n\n- Create a new Express.js server with `npx @autom8te/create-starter-templates@latest -n <project_name> --express`. Replace `project_name` with your camelCase project name\n- Navigate to new project folder\n- Run `yarn`\n- Run `yarn start`\n- Go to `http://localhost:8100` in browser\n\nYou can also set the backend port with `--be-port`. Setting the backend port allows you to customize the ports used by all backend services, which as of now is the Express server and all local Supabase services. As of now, 10 digits of the ports will be used.\n\nThe important ones to know are\n\n- `1`: Supabase's API port\n- `3`: Supabase's self hosted UI\n- `8`: Express server\n\nAll other ports can be seen in Supabase's `config.toml` file generated in `/supabase`.\n\nFor example, `npx @autom8te/create-starter-templates@latest -n <project_name> --express --be-port 7654` will set a backend base port of `765#` that will be used for all backend services.\n\n> [!TIP]\n> You can create both project types in a single command with `npx @autom8te/create-starter-templates@latest -n <project_name> --nextjs --express`\n\n### Supabase Project Setup\n\nA local Supabase is already initialized for you in the Express project! This template runs `supabase init` and already has some SQL migrations in there.\n\n1. Express - Run `supabase start` in the project root.\n2. Express - Edit the `.env.shared` file's `SUPABASE_KEY` with the `service_role` key from the `supabase start`'s output.\n3. NextJs - Edit the `.env.local` file's\n\n- `NEXT_PUBLIC_SUPABASE_KEY` with the `anon` key from the `supabase start`'s output.\n- `NEXT_PUBLIC_SUPABASE_URL` with the `API URL` from the `supabase start`'s output.\n\n### Docker\n\nIn any of the projects, run `docker compose up -d --build`.\n\n> [!IMPORTANT]\n> In Express.js' template, make sure to have your env vars in `.env.local`.\n> In Next.js' template, make sure to update the `args` in `docker-compose.yml`.\n","readmeFilename":"README.md"}