vue3-typescript-threejs-boilerplate

A boilerplate made to simplify the start of a Vue.JS and ThreeJS project.

入门
GitHub在线演示
Stars：11
License：MIT License
更新：2024/12/8

README

Vue.JS + Typescript + Three.JS Boilerplate?

Need info? | or Create an issue | Check our project Board

License

Table of Contents

Getting started

Project description

This project was made in order to simplify the start of a vue.js and three.js project. As they were not boilerplate available for this kind of technology, i decided to make one.

Prerequisites

This project uses the Yarn package manager to add dependencies and install them. Download the following software here :

Yarn

If you want, you can also use Docker with this application. It is not currently supported but you can make a PR to implement it.

Cloning and starting the project

If you want to start using this boilerplate you can clone the repo using this command :

git clone [email protected]:NezaelHD/vue3-typescript-threejs-boilerplate.git

In order to install all needed packages, launch the following command :

yarn install

You are now ready to develop you own project thank's to the boilerplate.

About the project

Features

Here are the differents commands available in the project :

  • yarn dev : Start a local web server in order to refresh the project when you make modifications in files.
  • yarn build : Generate a fresh build ready for production
  • yarn preview : Start a local web server that serves the built solution from the /distfolder
  • yarn lint: Check all the .ts and .vuefile in the project to fix them in order to have a good code quality.

This project is using a GitHub Action for prettier so if you forgot to launch the yarn lintcommand, it will launch it for you when you will commit and push the differents fixes made. Here is the link to the used GitHub Action which was made by a person of the community.

Here are the differents technology used by the project :

TypeScript Vue.JS Three.JS Vite Prettier Sass

How to contribute

If you have some ideas, you can submit them by creating issues here: Create an issue

If you want to maintain this boilerplate, you can also fork the project and then make the modifications you want. Once done make a pull request and i will review it and then if it is all good i will merge it.