Skip to content

Commit ccb4b5b

Browse files
alvarosabualvarosabu
committed
First Pass processed
0 parents  commit ccb4b5b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+14553
-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?

‎.prettierrc.cjs

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
module.exports = {
2+
...require('@alvarosabu/prettier-config'),
3+
printWidth: 120,
4+
}

‎.vscode/extensions.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"recommendations": ["Vue.volar", "Vue.vscode-typescript-vue-plugin"]
3+
}

‎CHANGELOG.md

Whitespace-only changes.

‎CODE_OF_CONDUCT.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others’ private information, such as a physical or electronic address, without explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team by DM at [TresJS Discord](https://discord.gg/tfY9aSNT). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

‎CONTRIBUTING.md

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
![repository-banner.png](/public/github-banner.png)
2+
3+
# Tres Contributing Guide
4+
5+
Hi there!! If you are reading this guide, you are probably interested in contributing to Tres. You're awesome 🤩.
6+
7+
No contribution is too small, whether it is a typo in the docs, a bug report or refactoring a piece of code, every contribution is welcome, just make sure to follow the guidelines below ✌️.
8+
9+
Thanks from the heart 💚 for taking the time to help out. This guide will help you to get started with the project.
10+
11+
## Setup
12+
13+
Tresjs is a monorepo using [pnpm workspaces](https://pnpm.io/workspaces). Pnpm is a package manager that is faster than npm and yarn, and it also uses symlinks to avoid code duplication.
14+
15+
Make sure you are using [Node.js](https://nodejs.org/en/) version 14 or higher.
16+
17+
You can install pnpm using npm:
18+
19+
```bash
20+
npm install -g pnpm
21+
```
22+
23+
or using homebrew:
24+
25+
If you have the package manager installed, you can install pnpm using the following command:
26+
27+
```
28+
brew install pnpm
29+
```
30+
31+
To develop Tres core or any of the packages, run `pnpm install` in the root of the project. This will install all the dependencies and link the packages together. There is also a `postinstall` script that will build all the packages.
32+
33+
## Development
34+
35+
TresJS is an ecosystem of packages, each one of them has its own purpose. The main package is `@tresjs/core` which is the core of the library. The other packages are plugins that extend the core functionality, like `@tresjs/cientos` which is a plugin that adds a bunch abstractions and composables to make it easier to create 3D scenes.
36+
37+
### Core
38+
39+
You can go to the `packages/tres` folder and run `pnpm dev` to start the dev server. This will start a vite server that will watch for changes in the code and rebuild the package.
40+
41+
This is only a playground to test the core package, to keep the `App.vue` clean create a new component with your scene and import it in the `App.vue` file.
42+
43+
### Cientos
44+
45+
You can go to the `packages/cientos` folder and run `pnpm build --watch` to build the package and watch for changes. That way you can test the changes in the playground on the `packages/tres` folder.
46+
47+
### Docs
48+
49+
The docs are built using [vitepress](https://vitepress.vuejs.org/).
50+
51+
You can run `pnpm docs:dev` to start the dev server for the documentation. All the docs are located in the `docs` folder in markdown.
52+
53+
If you are adding a new page, make sure to add it to the `docs/.vitepress/config.ts` file following the sidebar structure.
54+
55+
### Testing
56+
57+
Currently there are no tests in place, but we are working on it. If you want to contribute with tests, please open an issue first to discuss the best approach.
58+
59+
## Pull Requests
60+
61+
Before opening a pull request, make sure to run `pnpm lint` to make sure the code is following the code style.
62+
63+
- Checkout a topic branch from the base branch `main` branch and merge back against that branch.
64+
- Please follow the [commit message conventions](https://www.conventionalcommits.org/en/v1.0.0-beta.4/) when committing your changes. This is important because the release notes will be automatically generated from these messages. Small scoped commits are always preferred, as it is easier to review them.
65+
- If adding new feature:
66+
- Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it greenlighted before working on it. We would reject feature PRs that are not first opened as suggestions except for trivial changes.
67+
- Create a `feature/{issue-number}-add-test-to-core` branch for this feature. Make the name meaningful.
68+
- PR title must start with `feat(pkg): Descriptive title`. For example: `feat(core): added unit test to composables`.
69+
- If fixing a bug 🐛:
70+
71+
- Provide detailed description of the bug in the PR. Live demo preferred.
72+
- Create a `fix/{issue-number}-fix-test-in-core` branch for this bug fix.
73+
- If you are resolving a special issue, add `(fix #xxx[,#xxx])` (#xxx is the issue id) in your PR title for a better release log, e.g. `update entities encoding/decoding (fix #3899)`.
74+
75+
## Keep core small
76+
77+
The core package should be as small as possible, it should only contain the core functionality of the library. If you are adding a new feature, please consider adding it as a plugin instead, for example, if you want to add support for [Effect Composer](https://threejs.org/examples/?q=compo#webgl_postprocessing_effectcomposer) you should create a new package called `@tresjs/postprocessing` and add it as a plugin. If it's a smaller scope you can always add it to `cientos` package.

‎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

+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
![repository-banner.png](/public/repo-banner.png)
2+
3+
<p align="center">
4+
<a href="https://www.npmjs.com/package/@tresjs/core"><img src="https://img.shields.io/npm/v/@tresjs/core?color=%2382DBCA" alt="npm package"></a>
5+
6+
<a href="https://discord.gg/tfY9aSNT"><img src="https://img.shields.io/badge/chat-discord-purple?style=flat&logo=discord" alt="discord chat"></a>
7+
8+
</p>
9+
<br/>
10+
11+
# Post-Processing
12+
13+
> Collection of useful helpers and fully functional, ready-made abstractions for Tres
14+
15+
- 💡 Build a 3D scene working only with Vue components.
16+
- ⚡️ Powered by Vite
17+
- 🥰 It brings all the updated features of ThreeJS right awayregardless the version
18+
- 🦾 Fully Typed
19+
20+
Cientos (Spanish word for "hundreds", pronounced /θjentos/ ) is is a collection of useful ready-to-go helpers and components that are not part of the core package. The name uses the word uses in spanish to multiply by 100, to refer to the potential reach of the package to hold a amazing abstractions.
21+
22+
The postprocessing package uses three-stdlib module under the hood instead of the three/examples/jsm module. This means that you don't need to extend the catalogue of components using the extend method from the `core`, postprocessing does it for you.
23+
24+
It just works. 💯
25+
26+
## Installation
27+
28+
```bash
29+
pnpm i @tresjs/cientos
30+
```
31+
32+
## Docs
33+
34+
Checkout the [docs](https://cientos.tresjs.org/)
35+
36+
## Demos
37+
38+
- [Stackblitz Collection](https://stackblitz.com/@alvarosabu/collections/tresjs)
39+
40+
## Contributing
41+
42+
We are open to contributions, please read the [contributing guide](/CONTRIBUTING.md) to get started.
43+
44+
### Build
45+
46+
To build the package run:
47+
48+
```bash
49+
pnpm run build
50+
```
51+
52+
### Playground
53+
54+
To run the playground run, its a great way to test the components and helpers locally:
55+
56+
First install dependencies
57+
58+
```
59+
pnpm i
60+
```
61+
62+
And then to run the development server on http://localhost:5173
63+
64+
```bash
65+
pnpm run playground
66+
```
67+
68+
### Test
69+
70+
TODO...
71+
72+
### Docs
73+
74+
To run de docs in dev mode
75+
76+
```bash
77+
pnpm run docs:dev
78+
```
79+
80+
To build them
81+
82+
```bash
83+
pnpm run docs:build
84+
```
85+
86+
## License
87+
88+
[MIT](/LICENSE)
89+
90+
## Sponsors
91+
92+
Be the first to support this project [here](https://github.com/sponsors/alvarosabu) ☺️

‎package.json

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
{
2+
"name": "@tresjs/post-processing",
3+
"description": "Post-processing library for TresJS",
4+
"version": "0.1.0",
5+
"type": "module",
6+
"author": "Alvaro Saburido <[email protected]> (https://github.com/alvarosabu/)",
7+
"files": [
8+
"dist"
9+
],
10+
"license": "MIT",
11+
"main": "./dist/tres-postprocessing.umd.cjs",
12+
"module": "./dist/tres-postprocessing.js",
13+
"types": "./dist/index.d.ts",
14+
"exports": {
15+
".": {
16+
"import": "./dist/tres-postprocessing.js",
17+
"require": "./dist/tres-postprocessing.umd.cjs"
18+
},
19+
"./styles": "./dist/style.css",
20+
"./*": "./dist/tres-postprocessing.js"
21+
},
22+
"publishConfig": {
23+
"access": "public"
24+
},
25+
"scripts": {
26+
"dev": "vite",
27+
"playground": "cd playground && nr dev",
28+
"build": "vite build",
29+
"preview": "vite preview",
30+
"release": "release-it",
31+
"lint": "eslint . --ext .js,.jsx,.ts,.tsx,.vue",
32+
"docs:dev": "vitepress dev docs",
33+
"docs:build": "vitepress build docs",
34+
"docs:preview": "vitepress preview docs"
35+
},
36+
"peerDependencies": {
37+
"@tresjs/core": "2.0.0-beta.8",
38+
"three": "latest",
39+
"vue": "^3.2.47"
40+
},
41+
"dependencies": {
42+
"@vueuse/core": "^10.0.2",
43+
"postprocessing": "^6.30.2",
44+
"three": "^0.151.3",
45+
"three-stdlib": "^2.21.8",
46+
"vue": "^3.2.47"
47+
},
48+
"devDependencies": {
49+
"@alvarosabu/prettier-config": "^1.3.0",
50+
"@release-it/conventional-changelog": "^5.1.1",
51+
"@tresjs/core": "2.0.0-beta.9",
52+
"@types/three": "^0.150.1",
53+
"@vitejs/plugin-vue": "^4.1.0",
54+
"kolorist": "^1.7.0",
55+
"pathe": "^1.1.0",
56+
"prettier": "^2.8.7",
57+
"release-it": "^15.10.1",
58+
"rollup-plugin-analyzer": "^4.0.0",
59+
"rollup-plugin-visualizer": "^5.9.0",
60+
"typescript": "^5.0.4",
61+
"unocss": "^0.51.4",
62+
"vite": "^4.2.1",
63+
"vite-plugin-banner": "^0.7.0",
64+
"vite-plugin-dts": "2.3.0",
65+
"vitepress": "1.0.0-alpha.72",
66+
"vue-tsc": "^1.2.0"
67+
}
68+
}

0 commit comments

Comments
 (0)