npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

vite-3

v1.0.0-beta0.4

Published

CLI tool for creating Three.js Vite projects with GLSL support

Downloads

211

Readme

Vite-3 - Vite + ThreeJs App Generator

Vite-3-Logo

Vite-3 is a project generator for creating Vite-based Three.js applications. It provides boilerplate code for both JavaScript and TypeScript projects, with options for Basic or Shader-based templates. Additionally, Tailwind CSS can be integrated for styling.

✨ Features

  • Supports JavaScript and TypeScript variants.
  • Provides two project types:
    • Basic: Simple Three.js project with basic geometry and materials.
    • Shaders: Three.js project using custom GLSL shaders.
  • Optional integration with Tailwind CSS.
  • Automatically sets up Vite for development and bundling.
  • Pre-configured with Vite GLSL plugin for shader support.

📦 Installation

To install Vite-3 globally:

npm install -g vite-3

🛠️ Usage

Run the following command to scaffold a new Vite Three.js project:

vite-3  OR   vite3

You will be prompted to provide the following details:

  1. Project Name: The name of your project.
  2. Project Type: Choose between basic or shaders.
  3. Variant: Choose between JavaScript or TypeScript.
  4. Tailwind CSS: Option to include Tailwind CSS for styling.

After answering the prompts, the project structure will be created, and all dependencies will be installed.

📑 Project Structure

The generated project will have the following structure:

project-name/
│
├── index.html              # Main HTML file
├── package.json            # Project metadata and scripts
├── vite.config.js          # Vite configuration file
├── src/
│   ├── main.js|ts          # Entry point of the Three.js project
│   ├── styles.css          # Main styles (includes Tailwind if selected)
│   └── shaders/            # (For shader projects) GLSL files
├── tsconfig.json           # (For TypeScript projects) TypeScript configuration
└── node_modules/           # Project dependencies

📜 Available Scripts

Inside the project directory, you can run:

  • npm run dev: Starts the development server with Vite.
  • npm run build: Builds the project for production.

For TypeScript projects, the build command will first compile the TypeScript files.

🌟 Meet the Visionary Behind Shader3

In the heart of the dynamic world of web development, the creator of Shader is making waves with their unique visions and unwavering determination.

🎮 Aayush Chouhan - @aayushchouhan24

Aayush Chouhan

Aayush Chouhan, a tech lover and gaming enthusiast, embarked on a journey through cyberspace. From freelancing to diving into web and Android development, he honed his skills in programming languages. Joining Sheryians, he embraced Three.js, immersing himself in the captivating realm of 3D graphics, marking an exciting milestone in his career.

Instagram LinkedIn GitHub

🤝 Contributing

We welcome contributions! If you have ideas for new features, bug fixes, or improvements, feel free to open an issue or submit a pull request on our GitHub repository.

📄 License

Vite-3 is licensed under the MIT License. For more information, refer to the LICENSE file.

🙌 Acknowledgements

  • Vite: The Build Tool for the Web.

  • Three.js: The core library for 3D rendering.