Skip to content

anthonypena97/threejs-boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Three.js Boilerplate

Interactive 3D Model Web Page Renderer Boilerplate using Three.js

MIT License badge

brasil-fuerte-demo

Sample Sites:

----------------------------------------

Application written in Typescript, using Three.Js for WebGl 3D Model Rendering.

THREE.interactive by Markus Lerner is used for 3D Object interactivity.

Description

A simple site rendering a 3D Box which a user may click and be redirected to my Brasilian Top Hits Spotify Playlist.

Creator Message

Feel free to use this as boilerplate for your own desktop/mobile three.js applications! Peace!

Table of Contents

Usage

To experience the deployed site for the boilerplate, simply visit Brasil Fuerte

Installation

To use code for yourself :

  • download or clone application
  • open terminal in application root directory
  • enter,npm i
  • enter, npm run dev for development
  • enter, npm run build once complete
  • copy new bundle.js, index.html, and any public assets from dist/client/ folder
  • use copied files for deployment

Notes

This application has been tested through and written for Chrome v.97, Safari v.14, iOS v.14, Safari iOs, Chrome iOs, and Instagram. This application is responsive to both Desktop and Mobile use cases.

License

MIT License

Copyright (c) 2022 Anthony Pena

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation fil (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge,publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Version History

Contributing

Please refer to the Contributor Covenenant for guidelines on contributing on this project.

Questions

For any inquiries or questions, please contact Anthony Pena via:

Acknowledgments

Inspiration, code snippets, etc.