Skip to content

Commit aaf096a

Browse files
committed
update README
1 parent 986a4fb commit aaf096a

File tree

2 files changed

+90
-2
lines changed

2 files changed

+90
-2
lines changed

README.md

+90-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,95 @@
1-
# Vue 3 + Vite
1+
<h1 align="center">Three.js + Cannon.js</h1>
2+
3+
<div align="center" id="top">
4+
<img src="./src/img/sreen.png" alt="Physic 3d" style="max-width: 400px;"/>
5+
</div>
6+
&#xa0;
7+
8+
<p align="center">
9+
<img alt="Github top language" src="https://img.shields.io/github/languages/top/matmon12/physic-3d?color=42d392">
10+
11+
<img alt="Github language count" src="https://img.shields.io/github/languages/count/matmon12/physic-3d?color=d36449">
12+
13+
<img alt="Repository size" src="https://img.shields.io/github/repo-size/matmon12/physic-3d?color=4cc71e">
14+
15+
<img alt="License" src="https://img.shields.io/github/license/matmon12/physic-3d?color=56BEB8">
16+
17+
<img alt="Github stars" src="https://img.shields.io/github/stars/matmon12/physic-3d?color=56BEB8" />
18+
</p>
19+
20+
<p align="center">
21+
<a href="#dart-about">About</a> &#xa0; | &#xa0;
22+
<a href="#sparkles-features">Features</a> &#xa0; | &#xa0;
23+
<a href="#rocket-technologies">Technologies</a> &#xa0; | &#xa0;
24+
<a href="#white_check_mark-requirements">Requirements</a> &#xa0; | &#xa0;
25+
<a href="#checkered_flag-starting">Starting</a> &#xa0; | &#xa0;
26+
<a href="#memo-license">License</a> &#xa0; | &#xa0;
27+
<a href="https://github.com/matmon12" target="_blank">Author</a>
28+
</p>
29+
30+
<br>
31+
32+
## :dart: About
33+
34+
Website using 3D graphics and physics libraries. The scene contains 3D letters with collision and dodecahedron figures, also with collision. The figures move after the cursor. There is also a slight camera movement when moving the cursor. There are small settings for changing some parameters.
35+
36+
## :sparkles: Features
37+
38+
:heavy_check_mark: Movement of figures following the cursor;\
39+
:heavy_check_mark: Camera movement when moving cursor;\
40+
:heavy_check_mark: Changing text, figure material and environment map.
41+
42+
## :rocket: Technologies
43+
44+
The following tools were used in this project:
45+
46+
- [Vue](https://vuejs.org/)
47+
- [VueUse](https://vueuse.org/)
48+
- [Pinia](https://pinia.vuejs.org/)
49+
- [Vite](https://vitejs.dev/)
50+
- [Vue-router](https://router.vuejs.org/)
51+
- [TroisJS](https://troisjs.github.io/?ref=madewithvuejs.com)
52+
- [Cannon-es](https://pmndrs.github.io/cannon-es/)
53+
- [Lodash.debounce](https://lodash.com/)
54+
- [Three.js](https://threejs.org/)
55+
56+
## :white_check_mark: Requirements
57+
58+
Before starting :checkered_flag:, you need to have [Git](https://git-scm.com) and [Node](https://nodejs.org/en/) installed.
59+
60+
## :checkered_flag: Starting
61+
62+
```bash
63+
# Clone this project
64+
$ git clone https://github.com/matmon12/physic-3d
65+
66+
# Access
67+
$ cd physic-3d
68+
69+
# Install dependencies
70+
$ npm install
71+
72+
# Run the project
73+
$ npm run dev
74+
75+
# Compiles and minifies for production
76+
$ npm run build
77+
```
78+
79+
### Vue 3 + Vite
280

381
This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
482

5-
## Recommended IDE Setup
83+
### Recommended IDE Setup
684

785
- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
86+
87+
## :memo: License
88+
89+
This project is under license from MIT. For more details, see the [LICENSE](LICENSE) file.
90+
91+
Made with :heart: by <a href="https://github.com/matmon12" target="_blank">Matmon</a>
92+
93+
&#xa0;
94+
95+
<a href="#top">Back to top</a>

src/img/sreen.png

2.52 MB
Loading

0 commit comments

Comments
 (0)