Skip to content

Commit 12e287f

Browse files
author
JakobHock
committed
Initial commit
0 parents  commit 12e287f

20 files changed

+1916
-0
lines changed

.gitignore

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
pnpm-debug.log*
8+
lerna-debug.log*
9+
10+
node_modules
11+
dist
12+
dist-ssr
13+
*.local
14+
15+
# Editor directories and files
16+
.vscode/*
17+
!.vscode/extensions.json
18+
.idea
19+
.DS_Store
20+
*.suo
21+
*.ntvs*
22+
*.njsproj
23+
*.sln
24+
*.sw?

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022-present, (alvarosabu) Alvaro Saburido and Tres contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
![repo-banner](https://github.com/Tresjs/playground/raw/main/public/github-banner.png)
2+
3+
# TresJS 🚀 Starter
4+
5+
> Quick start repo for [Tres.js](https://tresjs.org) projects
6+
7+
## Features
8+
9+
- [Tres.js](https://tresjs.org) and latest [Three.js](https://threejs.org)
10+
- `@tresjs/cientos` package pre-installed 📦
11+
- Shader support (glsl) with [`vite-plugin-glsl`](https://github.com/UstymUkhman/vite-plugin-glsl) 🎨
12+
13+
## Usage
14+
15+
```bash
16+
npx degit tresjs/starter my-tres-project
17+
```
18+
19+
## Install
20+
21+
```bash
22+
cd my-tres-project
23+
pnpm install
24+
```
25+
26+
## Run
27+
28+
```bash
29+
pnpm dev
30+
```
31+
32+
## Build
33+
34+
```bash
35+
pnpm build
36+
```

index.html

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<title>TresJS</title>
5+
<meta charset="UTF-8" />
6+
<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
7+
<meta name="viewport" content="width=device-width" />
8+
</head>
9+
<body>
10+
<div id="app"></div>
11+
<script type="module" src="/src/main.ts"></script>
12+
</body>
13+
</html>

package.json

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
{
2+
"name": "@tresjs/starter",
3+
"type": "module",
4+
"version": "1.0.0",
5+
"description": "Quick starter template for TresJS",
6+
"author": "Alvaro Saburido <[email protected]> (https://github.com/alvarosabu/)",
7+
"license": "MIT",
8+
"keywords": [
9+
"vue",
10+
"tresjs",
11+
"webgl",
12+
"vite",
13+
"3d",
14+
"threejs",
15+
"three",
16+
"threejs-vue"
17+
],
18+
"scripts": {
19+
"dev": "vite",
20+
"build": "vue-tsc && vite build",
21+
"preview": "vite preview",
22+
"lint": "eslint .",
23+
"lint:fix": "eslint . --fix"
24+
},
25+
"dependencies": {
26+
"@tresjs/cientos": "4.0.3",
27+
"@tresjs/core": "4.3.0",
28+
"@tresjs/leches": "^0.14.0",
29+
"three": "^0.169.0",
30+
"vue": "^3.5.12"
31+
},
32+
"devDependencies": {
33+
"@types/three": "^0.169.0",
34+
"@vitejs/plugin-vue": "^5.1.4",
35+
"eslint": "^9.12.0",
36+
"typescript": "^5.6.3",
37+
"vite": "^5.4.8",
38+
"vite-plugin-glsl": "^1.3.0",
39+
"vue-tsc": "^2.1.6"
40+
}
41+
}
42+

0 commit comments

Comments
 (0)