From 7d1eb43e93bff116933c188360fb10c79c9cbd83 Mon Sep 17 00:00:00 2001 From: Tiphaine Durand <85015407+tidurand@users.noreply.github.com> Date: Fri, 5 Jul 2024 16:08:45 +0200 Subject: [PATCH 1/2] =?UTF-8?q?=F0=9F=93=9D=20Update=20README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3673663..f1e9f76 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Webflow dev template +# Webflow Dev Template A template for starting all your Webflow projects requiring code. Looks like the one of [finsweet](https://github.com/finsweet/developer-starter) but it's easily customable. From 8ba4fb72d2e4dfe57f9a19a4075aaeeb9d84e265 Mon Sep 17 00:00:00 2001 From: Tiphaine Durand <85015407+tidurand@users.noreply.github.com> Date: Fri, 5 Jul 2024 18:33:38 +0200 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=93=9D=20Update=20README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 33 ++++++++++++--------------------- 1 file changed, 12 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index f1e9f76..66711c3 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # Webflow Dev Template A template for starting all your Webflow projects requiring code. -Looks like the one of [finsweet](https://github.com/finsweet/developer-starter) but it's easily customable. +It looks like the one of [finsweet](https://github.com/finsweet/developer-starter) but it's easily customizable. ## Requirements -Install pnpm on you computer +Install pnpm on your computer ```bash npm i -g pnpm ``` @@ -23,14 +23,14 @@ Got a npm token (named NPM_TOKEN) : [How to do](https://docs.npmjs.com/creating- - Allow GitHub Actions to create and approve pull requests. ```Settings > Secrets and variables > Actions > New repository secret ``` -- Name : NPM_TOKEN -- Secret : you token +- Name: NPM_TOKEN +- Secret: you token 3. Install dependencies ```bash pnpm install ``` -You can start your project ! Here two usefull script +You can start your project! Here are two useful scripts: Dev mode (with live reload) ```bash @@ -55,33 +55,24 @@ Webflow.push(() => { ## Deployment -### Requirements - -#### Got a NPM Token - -#### Change Github Settings - - -### Steps - ```bash pnpm changeset ``` Then push your code, -In GitHub, when CI/CD fininshed, you will have a pull request, merge it and you're done ! +In GitHub, when CI/CD is finished, you will have a pull request, merge it and you're done! Your package will appear in npm. ## Tools -The avantage of this template is you can easily change each tool to suit your own configuration. +The advantage of this template is you can easily change each tool to suit your configuration. ### Finsweet ts-utils (don't change) -Finsweet made a HUGE work by typing the Webflow.js file which includes in all Webflow project. +Finsweet did a HUGE work by typing the Webflow.js file included in all Webflow projects. -With this, you can access to many types and methods not provided by Webflow. +With this, you can access many types and methods not provided by Webflow. ### ESBuild @@ -89,13 +80,13 @@ A fast JavaScript bundler and minifier that compiles and packages JavaScript and Update builder/esbuild.js -It include a live reload in builder/live-reload.js +It includes a live reload in builder/live-reload.js ### TSConfig A configuration file for TypeScript that specifies the compiler options and file paths required to compile a TypeScript project. -Update tsconfig. json +Update tsconfig.json ### ESLint @@ -123,7 +114,7 @@ Update .changeset/config.json ### CI/CD -This pipeline use GitHub Actions +This pipeline uses GitHub Actions #### Lint