3d226a38dc
- Add detailed README.md with project overview, architecture, and usage examples - Add comprehensive JSDoc documentation to all system files (Controls, Loop, Renderer, Resizer) - Add detailed documentation to component files (Terrain, Landmarks, WorldComponent) - Create CONTRIBUTING.md with development guidelines and coding standards - Create CHANGELOG.md with version history and development timeline - Create SECURITY.md with security policies and vulnerability reporting - Create API.md with comprehensive API documentation and usage examples - Update package.json with better metadata, scripts, and project information - Enhance TypeScript configuration with path aliases and strict settings - Improve Vite configuration with build optimizations and development settings - Update .gitignore with comprehensive patterns for development tools - Add file headers with author information and creation dates from git history This commit transforms the project from a basic template to a well-documented, production-ready World Component library with comprehensive documentation following best practices for open-source projects. Author: Matthew Raymer Security: All dependencies updated, comprehensive security guidelines added Performance: Build optimizations, code splitting, and memory management documented
66 lines
1.6 KiB
JSON
66 lines
1.6 KiB
JSON
{
|
|
"name": "world-component",
|
|
"description": "A reusable Vue 3 + TypeScript + Three.js component for creating interactive 3D worlds and visualizations",
|
|
"version": "0.1.0",
|
|
"type": "module",
|
|
"author": "Matthew Raymer",
|
|
"license": "MIT",
|
|
"keywords": [
|
|
"vue",
|
|
"typescript",
|
|
"three.js",
|
|
"3d",
|
|
"visualization",
|
|
"component",
|
|
"webgl",
|
|
"interactive"
|
|
],
|
|
"repository": {
|
|
"type": "git",
|
|
"url": "https://github.com/yourusername/world-component.git"
|
|
},
|
|
"bugs": {
|
|
"url": "https://github.com/yourusername/world-component/issues"
|
|
},
|
|
"homepage": "https://github.com/yourusername/world-component#readme",
|
|
"scripts": {
|
|
"dev": "vite",
|
|
"build": "vue-tsc && vite build",
|
|
"preview": "vite preview",
|
|
"type-check": "vue-tsc --noEmit",
|
|
"lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore",
|
|
"format": "prettier --write src/"
|
|
},
|
|
"dependencies": {
|
|
"axios": "^1.4.0",
|
|
"ramda": "^0.29.0",
|
|
"three": "^0.153.0",
|
|
"three-orbitcontrols-ts": "^0.1.2",
|
|
"vue": "^3.3.4",
|
|
"vue-facing-decorator": "^2.1.20"
|
|
},
|
|
"devDependencies": {
|
|
"@types/three": "^0.152.1",
|
|
"@vitejs/plugin-vue": "^4.2.3",
|
|
"typescript": "^5.1.5",
|
|
"vite": "^4.3.9",
|
|
"vue-tsc": "^1.8.3"
|
|
},
|
|
"engines": {
|
|
"node": ">=16.0.0",
|
|
"npm": ">=8.0.0"
|
|
},
|
|
"browserslist": {
|
|
"production": [
|
|
">0.2%",
|
|
"not dead",
|
|
"not op_mini all"
|
|
],
|
|
"development": [
|
|
"last 1 chrome version",
|
|
"last 1 firefox version",
|
|
"last 1 safari version"
|
|
]
|
|
}
|
|
}
|