Skip to content

XAOSTECH/portfolio.xaostech.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

21 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

portfolio.xaostech.io

GitHub repo GitHub release License

CI Status Issues Pull Requests Stars Forks

Last Commit Repo Size Code Size Contributors

Stability Maintenance


portfolio worker


πŸ“‹ Table of Contents


πŸ” Overview

Interactive portfolio showcase with Three.js animations:

  • Project gallery with details
  • 3D animations & visualizations
  • Media management (proxied to data.xaostech.io)
  • Responsive design via Astro

Why portfolio.xaostech.io?

Dedicated portfolio SSG hosted on Cloudflare Pages. Features:

  • Static site generation (Astro)
  • Three.js for interactive elements
  • Media delegation to data worker

✨ Features

  • 🎨 Three.js Animations - Interactive 3D visualizations
  • πŸ“Έ Media Gallery - Images/videos via data worker
  • πŸ“± Responsive Design - Mobile-first approach
  • ⚑ Static Generation - Pre-built, ultra-fast
  • πŸ” SEO Optimized - Open Graph, meta tags

πŸ“₯ Installation

Prerequisites

  • Node.js 18+
  • Cloudflare account (for Pages deployment)

Quick Start

# Clone the repository
git clone https://github.com/XAOSTECH/portfolio.xaostech.io.git
cd portfolio.xaostech.io

# Install dependencies
npm install

# Local development
npm run dev

# Build for production
npm run build

# Deploy to Cloudflare Pages
npm run deploy
```bash
# Clone the repository
git clone https://github.com/XAOSTECH/portfolio.xaostech.io.git
cd portfolio.xaostech.io

# Run installation
./install.sh

# Or manual installation
{{MANUAL_INSTALL_STEPS}}

Package Managers

# npm
npm install {{PACKAGE_NAME}}

# yarn
yarn add {{PACKAGE_NAME}}

# apt (Debian/Ubuntu)
sudo apt install {{PACKAGE_NAME}}

# brew (macOS)
brew install {{PACKAGE_NAME}}

πŸš€ Usage

Basic Usage

{{BASIC_USAGE_EXAMPLE}}

Advanced Usage

{{ADVANCED_USAGE_EXAMPLE}}

Examples

πŸ“˜ Example 1: {{EXAMPLE_1_TITLE}}
{{EXAMPLE_1_CODE}}
πŸ“— Example 2: {{EXAMPLE_2_TITLE}}
{{EXAMPLE_2_CODE}}

βš™οΈ Configuration

Environment Variables

Variable Description Default
{{ENV_VAR_1}} {{ENV_VAR_1_DESC}} {{ENV_VAR_1_DEFAULT}}
{{ENV_VAR_2}} {{ENV_VAR_2_DESC}} {{ENV_VAR_2_DEFAULT}}

Configuration File

# config.yml
{{CONFIG_FILE_EXAMPLE}}

πŸ“š Documentation

Document Description
πŸ“– Getting Started Quick start guide
πŸ“‹ API Reference Complete API documentation
πŸ”§ Configuration Configuration options
❓ FAQ Frequently asked questions

🀝 Contributing

Contributions are welcome! Please read our Contributing Guidelines before submitting PRs.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

See also: Code of Conduct | Security Policy


πŸ—ΊοΈ Roadmap

  • {{COMPLETED_FEATURE_1}}
  • {{COMPLETED_FEATURE_2}}
  • {{PLANNED_FEATURE_1}}
  • {{PLANNED_FEATURE_2}}
  • {{PLANNED_FEATURE_3}}

See the open issues for a full list of proposed features and known issues.


πŸ’¬ Support


πŸ“„ License

Distributed under the GPL-3.0 License. See LICENSE for more information.


πŸ™ Acknowledgments

  • {{ACKNOWLEDGMENT_1}}
  • {{ACKNOWLEDGMENT_2}}
  • {{ACKNOWLEDGMENT_3}}

⬆️ Back to Top

About

portfolio worker

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors