Skip to content

Latest commit

 

History

History
77 lines (49 loc) · 2.67 KB

README.md

File metadata and controls

77 lines (49 loc) · 2.67 KB
Raw

🌐 Webflow JS Template

Webflow Template License GitHub Stars GitHub Forks Project Status

📄 Description

The Webflow JS Template provides a simple and effective way to integrate custom JavaScript libraries like GSAP into Webflow projects. The template is designed to streamline your workflow, allowing you to test animations and interactions locally without publishing changes to Webflow each time.

🚀 Getting Started

Prerequisites

Ensure that you have the following installed:

Installation

  1. Clone the repository:

    git clone [email protected]:mirkotrotta/webflow-js-template.git
cd webflow-js-template

  2. Install dependencies:

    npm install

  3. Start the development server:

    npm run dev

    This will start a local development server at http://localhost:3000.

🔗 Connect to Webflow

To link your Webflow project with this local server:

  1. Go to Project Settings in Webflow.

  2. Navigate to Custom Code → Footer Code.

  3. Copy the contents of the tag file and paste it into the Footer Code section:

    <script type="module" src="http://localhost:3000/@vite/client"></script>
<script type="module" src="http://localhost:3000/src/index.js"></script>

  4. Save and publish your Webflow project.

Note: This setup only works when the local server is running. For deployment, additional configuration is needed and will be detailed in future documentation.

🛠 How to Use

Once connected, you can customize animations in the src/animations.js file and add additional JavaScript logic in src/interactions.js. Modify these files to suit your project needs and see changes in real-time without publishing to Webflow.

📜 License

This project is licensed under the MIT License. See the LICENSE file for more details.

👤 Author

Mirkotrotta