1.0.7 • Published 12 months ago

my-webflow-boilerplate v1.0.7

Weekly downloads
-
License
MIT
Repository
github
Last release
12 months ago

🌐 My Webflow Boilerplate

Welcome to My Webflow Boilerplate - your ultimate starting point for building stunning, high-performance websites with Webflow, enhanced with the power of modern web technologies like Vite, TypeScript, and SCSS.


šŸš€ Features

  • ⚔ Fast Development: Utilize Vite for an incredibly fast development and build process.
  • šŸ”’ Type Safety: Leverage TypeScript for safer code across your project.
  • šŸŽØ Advanced Styling: SCSS allows for more complex and maintainable stylesheets.
  • šŸ’„ Dynamic Interactions: GSAP and Swiper bring your site to life with animations and sliders.
  • šŸ“… Efficient Date Handling: Dayjs offers simple and powerful date manipulation.
  • āœ… Code Quality: Ensure high code quality with Prettier, ESLint, and Stylelint.
  • šŸ¤– Automated Workflows: Husky, Lint-staged, and Commitlint streamline your Git workflow.

šŸ“¦ Installation

Getting Started

  1. Clone the repository to get your own copy of the boilerplate:

    git clone https://github.com/your-username/my-webflow-boilerplate.git
  2. Navigate to your project directory and install the necessary dependencies:

    cd my-webflow-boilerplate
    npm install

šŸ›  Usage

Development Workflow

  • Start Development Server: Access your app at http://localhost:3000.

    npm run dev
  • Build for Production: Optimized files will be in the dist directory.

    npm run build
  • Preview Production Build: Preview your app at http://localhost:5000.

    npm run serve

šŸ“ Directory Structure

Understand the layout of the project for efficient navigation and management.

my-webflow-boilerplate/
ā”œā”€ā”€ src/
│   ā”œā”€ā”€ assets/
│   │   ā”œā”€ā”€ images/
│   │   ā”œā”€ā”€ fonts/
│   │   └── styles/
│   ā”œā”€ā”€ components/
│   ā”œā”€ā”€ libs/
│   └── utils/
ā”œā”€ā”€ .env
ā”œā”€ā”€ .eslintrc.js
ā”œā”€ā”€ .prettierrc
ā”œā”€ā”€ package.json
ā”œā”€ā”€ tsconfig.json
ā”œā”€ā”€ vite.config.ts
└── README.md

šŸ”§ Linting and Formatting

Ensuring Code Quality

  • ESLint: Lint your JavaScript/TypeScript for errors and code smells.
  • Prettier: Automatically format your code for consistency.
  • Stylelint: Keep your SCSS files clean and organized.

šŸŖ Git Hooks

Streamlining Git Operations

  • Husky: Manage Git hooks with ease.
  • Lint-staged: Lint only staged files to save time.
  • Commitlint: Enforce commit message conventions for better readability.

šŸ¤ Contributing

We welcome contributions! If you have suggestions or want to fix a bug, feel free to make a pull request.


šŸ“„ License

This project is open-sourced under the MIT License.


ā“ FAQs

Q: How do I update dependencies?

A: Run npm update to fetch the latest versions of your dependencies.

Q: Can I use this boilerplate for commercial projects?

A: Absolutely! This boilerplate is MIT licensed, meaning it's free for personal and commercial use.


šŸ“š Changelog

Stay up to date with the changes and improvements made to the boilerplate.

  • 1.0.6: Added new features and fixed bugs.
  • 1.0.5: Improved documentation and updated dependencies.
1.0.7

12 months ago

1.0.6

12 months ago

1.0.5

12 months ago

1.0.2

12 months ago

1.0.1

12 months ago

1.0.0

12 months ago