https://github.com/xavimondev/hauntedfolio
Hauntedfolio 🎃 - generates a fun, creepy portfolio to showcase your top repositories, languages, and bio, enhanced with spooky visuals and mysterious facts.
https://github.com/xavimondev/hauntedfolio
ai astro cloudinary
Last synced: about 2 months ago
JSON representation
Hauntedfolio 🎃 - generates a fun, creepy portfolio to showcase your top repositories, languages, and bio, enhanced with spooky visuals and mysterious facts.
- Host: GitHub
- URL: https://github.com/xavimondev/hauntedfolio
- Owner: xavimondev
- License: mit
- Created: 2024-10-10T03:45:30.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-10-29T19:59:40.000Z (6 months ago)
- Last Synced: 2025-02-27T04:11:27.116Z (2 months ago)
- Topics: ai, astro, cloudinary
- Language: TypeScript
- Homepage: https://hauntedfolio.vercel.app
- Size: 3.25 MB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Overview
HauntedFolio generates a fun, creepy portfolio to showcase your top repositories, languages, and bio, enhanced with spooky visuals and mysterious facts. The app creates a haunted-style video that highlights your projects in an unsettling way, offering a unique, spine-chilling way to display your skills. Powered by Cloudinary for image transformations and video generation, HauntedFolio is the perfect blend of tech and terror!
## Stack
- [Astro](https://astro.build/): The web framework for content-driven websites.
- [Cloudinary](https://cloudinary.com/): Image and Video API Platform.
- [Vercel AI SDK](https://sdk.vercel.ai/): The Vercel AI SDK to help developers build AI-powered applications.
- [Uptash](https://upstash.com/): Data caching.
- [Tailwindcss](https://tailwindcss.com/): A utility-first CSS framework for rapid UI development.
## Setting Up
### PUBLIC_CLOUDINARY_CLOUD_NAME
- Go to the [Cloudinary website](https://cloudinary.com/).
- Sign in to your account or create a new one.
- Navigate to dashboard’s page, you’ll see your Cloud Name.
- Copy the Cloud Name.
### PUBLIC_CLOUDINARY_API_KEY - CLOUDINARY_API_SECRET
- Navigate to Settings.
- Under API Keys, click on Generate API Key.
- Copy the generated API Key and API Secret.
### OPENAI_API_KEY
- Go to the [OpenAI website](https://openai.com/).
- Sign in to your account or create a new one.
- Navigate to your [API settings](https://platform.openai.com/account/api-keys).
- Generate an Secret key.
- Copy the generated Secret key.
### UPSTASH_REDIS_REST_URL - UPSTASH_REDIS_REST_TOKEN
- Go to the Uptash [console](https://console.upstash.com/).
- Sign in to your account or create a new one.
- Navigate to your database.
- Copy the generated keys.
## Run Locally
1.Clone the hauntedfolio repository:
```sh
git clone https://github.com/xavimondev/hauntedfolio
```
2.Rename the `.env.example` to `.env`:
```bash
mv .example.env .env
```
3.Install dependencies:
```bash
# bun
bun install
# pnpm
pnpm install
# npm
npm install
# yarn
yarn install
```
6.Start the development mode:
```bash
# bun
bun dev
# pnpm
pnpm dev
# npm
npm run dev
# yarn
yarn dev
```
## License
This project is licensed under the **MIT License** - see the [**MIT License**](https://github.com/xavimondev/hauntedfolio/blob/main/LICENSE) file for details.