chore: Added readme file
This commit is contained in:
parent
34655087d3
commit
1e79754534
68
README.md
Normal file
68
README.md
Normal file
@ -0,0 +1,68 @@
|
||||
# Builder Research
|
||||
|
||||
This repository is organized as a Turbo-powered workspace for weekly Three.js and React Three Fiber learning/Reasearching tasks.
|
||||
|
||||
## Repository Structure
|
||||
|
||||
```text
|
||||
builder-research/
|
||||
├── package.json # Root workspace + Turbo scripts
|
||||
├── turbo.json # Turbo pipeline config
|
||||
├── yarn.lock # Root dependency lockfile
|
||||
└── Week-1/
|
||||
├── GeneralNotes.md
|
||||
├── Week-1-PersonalSummary.md
|
||||
├── Days-update/
|
||||
├── Task-1/
|
||||
│ ├── TaskNotes.md
|
||||
│ ├── builder/ # Notes
|
||||
│ ├── vanilla/ # Three.js implementation
|
||||
│ │ ├── package.json
|
||||
│ │ ├── index.html
|
||||
│ │ └── main.js
|
||||
│ └── r3f/ # React Three Fiber implementation
|
||||
│ ├── package.json
|
||||
│ └── app/ # Full Vite React app
|
||||
│ ├── package.json
|
||||
│ ├── yarn.lock
|
||||
│ └── src/
|
||||
├── Task-2/
|
||||
│ ├── TaskNotes.md
|
||||
│ ├── builder/
|
||||
│ ├── vanilla/
|
||||
│ └── r3f/
|
||||
├── Task-3/
|
||||
│ ├── TaskNotes.md
|
||||
│ ├── builder/
|
||||
│ ├── vanilla/
|
||||
│ └── r3f/
|
||||
└── Task-4/
|
||||
├── TaskNotes.md
|
||||
├── builder/
|
||||
├── vanilla/
|
||||
└── r3f/
|
||||
```
|
||||
|
||||
## Folder Roles
|
||||
|
||||
- `Week-X/Task-Y/builder/`: notes docs.
|
||||
- `Week-X/Task-Y/vanilla/`: plain JavaScript + Three.js apps.
|
||||
- `Week-X/Task-Y/r3f/`: React Three Fiber app and its own dependencies..
|
||||
|
||||
## Workspace Notes
|
||||
|
||||
- Package manager: **Yarn (classic)**.
|
||||
- Root workspaces include:
|
||||
- `Week-*/Task-*/vanilla`
|
||||
- `Week-*/Task-*/r3f`
|
||||
- `builder` directories are intentionally not workspaces.
|
||||
|
||||
## Common Commands (from repo root)
|
||||
|
||||
```bash
|
||||
yarn install
|
||||
yarn dev
|
||||
yarn build
|
||||
yarn lint
|
||||
yarn clean
|
||||
```
|
||||
Loading…
x
Reference in New Issue
Block a user