Skip to content

joejo-joestar/joestar

Repository files navigation

🌐 joestar

car in clouds

my portfolio website :3

to run this project locally, you need to have Node.js installed. And then run the following commands:

npm i
npm run dev

πŸ™ Special Thanks


πŸ—‚οΈ Project Structure

Below is a compact tree of the most important files and folders with a short note about their purpose.

joestar
β”œβ”€β”€ eslint.config.js  # ESLint rules and configuration
β”œβ”€β”€ index.html        # App HTML entry point
β”œβ”€β”€ package.json      # npm scripts, dependencies
β”œβ”€β”€ README.md         # Project documentation
β”œβ”€β”€ tsconfig*.json    # TypeScript configuration files
β”œβ”€β”€ vercel.json       # Vercel deployment configuration
β”œβ”€β”€ vite.config.ts    # Vite build/dev server config
β”œβ”€β”€ public/          # Static assets served as-is
β”‚   β”œβ”€β”€ oneko.gif    # Oneko cat animation
β”‚   β”œβ”€β”€ oneko.js     # Oneko script used on the site
β”‚   └── pixlogo.png  # Logo image
└── src/              # Source code
    β”œβ”€β”€ catppuccin.css  # Theme / color tokens
    β”œβ”€β”€ index.css       # Global styles
    β”œβ”€β”€ main.tsx        # React app bootstrap
    β”œβ”€β”€ oneko.ts        # Oneko integration helper
    β”œβ”€β”€ vite-env.d.ts   # Vite/TypeScript types
    β”œβ”€β”€ api/             # Small API clients and fetchers
    β”‚   β”œβ”€β”€ repos.ts     # GitHub repo helpers
    β”‚   β”œβ”€β”€ spotify.ts   # Spotify "now playing" client
    β”‚   └── unsplash.ts  # Unsplash image fetcher
    β”œβ”€β”€ assets/  # Images used by the UI
    β”‚   β”œβ”€β”€ pix404.png
    β”‚   β”œβ”€β”€ pixcontact.png
    β”‚   β”œβ”€β”€ pixhi.png
    β”‚   β”œβ”€β”€ pixnow.png
    β”‚   β”œβ”€β”€ pixpics.png
    β”‚   └── pixprojects.png
    β”œβ”€β”€ components/        # Reusable UI components
    β”‚   β”œβ”€β”€ CategoryMenu/  # Category menu component
    β”‚   β”œβ”€β”€ Footer/        # Footer component
    β”‚   β”œβ”€β”€ MainGallery/   # Main gallery component
    β”‚   β”œβ”€β”€ Navbar/        # Navigation bar component
    β”‚   β”œβ”€β”€ NowPlaying/    # NowPlaying widget component
    β”‚   └── ProjectsList/  # Projects list component
    β”œβ”€β”€ hooks/  # Custom React hooks
    β”‚   β”œβ”€β”€ useHashPassword.tsx
    β”‚   β”œβ”€β”€ useMediaQuery.tsx
    β”‚   └── useScrollToTop.tsx
    β”œβ”€β”€ routes/         # Page routes (React Router)
    β”‚   β”œβ”€β”€ Contact/    # Contact page
    β”‚   β”œβ”€β”€ Home/       # Home page
    β”‚   β”œβ”€β”€ Missingno/  # 404 page
    β”‚   β”œβ”€β”€ Now/        # Now page
    β”‚   β”œβ”€β”€ Password/   # Password page
    β”‚   β”œβ”€β”€ Photos/     # Photos page
    β”‚   └── Projects/   # Projects page
    └── shared/           # Shared utilities / data
        └── socialsList.ts  # Social links used across the site

πŸ”Œ Related Repos

This website uses resources from two other repos


πŸ“‹ Todo

Go to the linked GitHiub Projects for a more flushed out "todo" list!