kaandesu / threesnap

[Work in Progress] Full screen, snap scroll library with ready-to-use three.js configurations.

Home Page:https://kaandesu.github.io/threesnap/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Logo

CSS3 Threejs TypeScript Vite

Threesnap

[Work in Progress] Full screen, snap scroll library with ready-to-use three.js configurations.

Live Demo · Report Bug · Request Feature

Table of Contents
  1. Usage
  2. Roadmap
  3. Contributing
  4. License
  5. Contact

Usage

⚠️ Library is still under construction. Please check back later.

Roadmap

  • create base npm package structure
  • snap scroll functionality
  • full screen components
  • three.js integration
  • configuration options for three.js
    • Object position and rotation on each scroll-snap
    • Fetching 3D model from url
  • update documentation
  • update licensing
  • add tests
  • Update example live-demo
  • Publish package to npm
  • Framework Wrappers
    • Vue3
    • React

Contributing

Contributions to the project is highly appreciated. If you have any suggestions/questions/requests please consider opening an issue. If you want to contribute to the project, fixing an open issue is greatly recommended and appreciated. To see the all contribution rules please check the contribution rules.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Maintainer E-Mail
kaandesu kaandesu00@gmail.com

About

[Work in Progress] Full screen, snap scroll library with ready-to-use three.js configurations.

https://kaandesu.github.io/threesnap/


Languages

Language:TypeScript 52.2%Language:CSS 39.1%Language:HTML 8.7%