{"_id":"@bryandelaitre/pulsor-lp-sitevolution","name":"@bryandelaitre/pulsor-lp-sitevolution","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@bryandelaitre/pulsor-lp-sitevolution","version":"1.0.0","description":"A template for starting all your Webflow projects requiring code. It looks like the one of [finsweet](https://github.com/finsweet/developer-starter) but it's easily customizable.","main":"dist/index.js","type":"module","module":"src/index.ts","keywords":[],"author":"","license":"ISC","devDependencies":{"@changesets/changelog-git":"^0.2.0","@changesets/cli":"^2.27.7","@eslint/js":"^9.6.0","@finsweet/ts-utils":"^0.40.0","@types/eslint__js":"^8.42.3","@types/node":"^20.14.9","cross-env":"^7.0.3","esbuild":"^0.23.0","eslint":"^8.57.0","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.1.3","globals":"^15.8.0","husky":"^9.0.11","prettier":"3.3.2","typescript":"^5.5.3","typescript-eslint":"^7.15.0"},"engines":{"node":">=20","pnpm":">=9"},"dependencies":{"gsap":"^3.12.5"},"scripts":{"dev":"cross-env BUILD_ENV=dev node ./builder/esbuild.js","build":"cross-env BUILD_ENV=prod node ./builder/esbuild.js","lint":"eslint ./src && prettier --check ./src","lint:fix":"eslint ./src --fix && prettier --write ./src","check":"tsc --noEmit","release":"changeset publish","reinstall":"rm -rf node_modules pnpm-lock.yaml && pnpm i"},"_id":"@bryandelaitre/pulsor-lp-sitevolution@1.0.0","_integrity":"sha512-2q1SdgNKmBYvryyrVAf1vYShyJ3SwJz0cSC9OJv6o0oFzsMYTBGlbSZG6O7qBLPQ9IYCYe/fLBV15ehwxCShZg==","_resolved":"/tmp/2de6ab8605c13d88feda1a08fae1ae24/bryandelaitre-pulsor-lp-sitevolution-1.0.0.tgz","_from":"file:bryandelaitre-pulsor-lp-sitevolution-1.0.0.tgz","_nodeVersion":"20.15.1","_npmVersion":"10.7.0","dist":{"integrity":"sha512-2q1SdgNKmBYvryyrVAf1vYShyJ3SwJz0cSC9OJv6o0oFzsMYTBGlbSZG6O7qBLPQ9IYCYe/fLBV15ehwxCShZg==","shasum":"90053e15ac77b18ab7c6857d0a36862a7f115f82","tarball":"https://registry.npmjs.org/@bryandelaitre/pulsor-lp-sitevolution/-/pulsor-lp-sitevolution-1.0.0.tgz","fileCount":3,"unpackedSize":78644,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDk5KJIAFcdE8Z5Dgm8N4Xq3M1OTLMz9RlWvR8ipk4FfwIhAPwqDmmqVN7TzALu5AQBiUFtlmO0oCWRDH4EudbH7mDh"}]},"_npmUser":{"name":"bryan_delaitre","email":"bryan.delaitre.study@gmail.com"},"directories":{},"maintainers":[{"name":"bryan_delaitre","email":"bryan.delaitre.study@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/pulsor-lp-sitevolution_1.0.0_1721231522805_0.72904240781637"},"_hasShrinkwrap":false}},"time":{"created":"2024-07-17T15:52:02.663Z","1.0.0":"2024-07-17T15:52:02.987Z","modified":"2024-07-17T15:52:03.359Z"},"maintainers":[{"name":"bryan_delaitre","email":"bryan.delaitre.study@gmail.com"}],"description":"A template for starting all your Webflow projects requiring code. It looks like the one of [finsweet](https://github.com/finsweet/developer-starter) but it's easily customizable.","keywords":[],"license":"ISC","readme":"# Webflow Dev Template\n\nA template for starting all your Webflow projects requiring code.\nIt looks like the one of [finsweet](https://github.com/finsweet/developer-starter) but it's easily customizable.\n\n## Requirements\n\nInstall pnpm on your computer\n```bash\nnpm i -g pnpm\n```\n\nGot a npm token (named NPM_TOKEN) : [How to do](https://docs.npmjs.com/creating-and-viewing-access-tokens)\n\n## Installation\n\n1. Click on Use this template > [Create a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template#creating-a-repository-from-a-template)\n2. Change some settings in your repository \n\n```Settings > Actions > General > Workflow Permissions```\n\n- Read and write permissions.\n- Allow GitHub Actions to create and approve pull requests.\n\n```Settings > Secrets and variables > Actions > New repository secret ```\n- Name: NPM_TOKEN\n- Secret: you token\n3. Install dependencies\n```bash\npnpm install\n```\n\nYou can start your project! Here are two useful scripts:\n\nDev mode (with live reload)\n```bash\npnpm dev\n```\n\nBuild (for production)\n```bash\npnpm build\n```\n\n4. Write your code in src/index.ts (don't touch Webflow.push but you should remove console.log)\n\n```typescript\nWebflow.push(() => {\n  //Write your code here\n\n  console.log('Hello World')\n})\n\n```\n\n## Deployment\n\n```bash\npnpm changeset\n```\nThen push your code,\n\nIn GitHub, when CI/CD is finished, you will have a pull request, merge it and you're done!\n\nYour package will appear in npm.\n\n## Tools\n\nThe advantage of this template is you can easily change each tool to suit your configuration.\n\n### Finsweet ts-utils (don't change)\n\nFinsweet did a HUGE work by typing the Webflow.js file included in all Webflow projects.\n\nWith this, you can access many types and methods not provided by Webflow.\n\n### ESBuild\n\nA fast JavaScript bundler and minifier that compiles and packages JavaScript and TypeScript code for deployment.\n\nUpdate builder/esbuild.js\n\nIt includes a live reload in builder/live-reload.js\n\n### TSConfig\n\nA configuration file for TypeScript that specifies the compiler options and file paths required to compile a TypeScript project.\n\nUpdate tsconfig.json\n\n### ESLint\n\nA static code analysis tool for JavaScript that identifies and fixes problems in your code to ensure adherence to specified coding standards and best practices.\n\nUpdate eslint.config.js\n\n### Prettier\n\nA code formatter for JavaScript that enforces consistent style by parsing code and reprinting it with its own rules.\n\nUpdate .prettierrc file.\n\n### Husky (Git hooks)\n\nA tool that enables Git hook scripts to run automatically, helping to enforce quality checks and other tasks during the development process.\n\nAdd hooks in .husky folder\n\n### Changeset (versioning)\n\nA tool for managing and automating the versioning and changelog generation process for projects, especially those using monorepos, by tracking changes across packages.\n\nUpdate .changeset/config.json\n\n### CI/CD\n\nThis pipeline uses GitHub Actions\n\n#### Lint\n\nCheck if your code got errors before going to production\n\nUpdate .github/workflows.ci.yml\n\n\n#### Release\n\nPublish package to npm\n\nUpdate .github/workflows.realease.yml\n","readmeFilename":"README.md"}