logo
0
0
Login

🪩 Vibeverse

让每一个 Vibe 都留在宇宙中。—— 黑客松与 AI 创意项目的持续化与共创平台。

一个让黑客松与 AI 创意项目被沉淀、被发现、被共创、被放大的平台。

✨ 特性

  • 🎨 黑白极简设计 - 现代极客风,暗色模式优先
  • 🔐 Clerk 认证 - 安全的用户认证系统(待集成)
  • 💾 Supabase 数据库 - PostgreSQL + Realtime(待集成)
  • Nuxt 3 + TypeScript - 现代化的开发体验
  • 🎯 Tailwind CSS - 原子化 CSS,快速开发
  • 🌓 暗/亮模式 - 完整的主题切换支持

📦 技术栈

  • 前端框架: Nuxt 3 + Vue 3
  • 样式: Tailwind CSS + CSS Variables
  • 语言: TypeScript
  • 认证: Clerk(待集成)
  • 数据库: Supabase(待集成)
  • 部署: Vercel

🚀 快速开始

环境要求

  • Node.js >= 18.x
  • pnpm >= 8.x(推荐)

安装

# 克隆仓库 git clone https://github.com/your-org/vibeverse.git cd vibeverse # 安装依赖 pnpm install # 复制环境变量 cp .env.example .env # 编辑 .env 填入配置

开发

# 启动开发服务器 pnpm dev # 访问 http://localhost:3000

构建

# 构建生产版本 pnpm build # 预览生产构建 pnpm preview

代码质量

# 代码检查 pnpm lint # 自动修复 pnpm lint:fix # 代码格式化 pnpm format # TypeScript 类型检查 pnpm typecheck # 运行测试(待配置) pnpm test

📁 项目结构

vibeverse/ ├── app/ # Nuxt 3 应用目录 │ ├── assets/ # 静态资源 │ │ └── styles/ # 样式文件 │ │ ├── theme.css # 设计系统 CSS Variables │ │ └── tailwind.css # Tailwind 入口 │ ├── components/ # Vue 组件 │ │ ├── ui/ # 基础 UI 组件 │ │ │ ├── Button.vue │ │ │ ├── Container.vue │ │ │ └── ThemeToggle.vue │ │ └── layout/ # 布局组件 │ │ ├── Navbar.vue │ │ └── Footer.vue │ ├── composables/ # Vue Composables │ │ └── useTheme.ts # 主题管理 │ ├── layouts/ # 页面布局 │ │ └── default.vue # 默认布局 │ └── pages/ # 页面路由 │ └── index.vue # 首页 ├── docs/ # 项目文档 │ ├── Vibeverse_PRD_Full.md │ ├── Vibeverse_Design_System.md │ ├── Development_Guide.md │ ├── Development_Plan.md │ ├── Git_Commit_Guidelines.md │ └── Coding_Standards.md ├── nuxt.config.ts # Nuxt 配置 ├── tailwind.config.ts # Tailwind 配置 ├── tsconfig.json # TypeScript 配置 ├── .eslintrc.cjs # ESLint 配置 ├── .prettierrc # Prettier 配置 └── package.json # 依赖管理

📚 文档

🛠️ 开发进度

✅ 已完成

  • 项目初始化与配置
  • 设计系统 CSS Variables
  • 暗/亮模式切换功能
  • 基础 UI 组件(Button, Container, ThemeToggle)
  • 布局组件(Navbar, Footer)
  • 首页布局和结构

🚧 进行中

  • Clerk 认证集成
  • Supabase 数据库集成
  • 项目投稿系统
  • 项目详情页

📅 计划中

  • 评论系统
  • 用户个人主页
  • 城市与活动页
  • 管理后台
  • 共创协作功能

🎨 设计原则

  • 黑白为主 - 极简极客风格
  • 暗色优先 - Dark Mode First
  • 留白至上 - 让内容呼吸
  • 性能优先 - 快速流畅的体验
  • 可访问性 - WCAG AA 标准

🤝 贡献指南

我们欢迎所有形式的贡献!请遵循以下步骤:

  1. Fork 本仓库
  2. 创建功能分支 (git checkout -b feature/amazing-feature)
  3. 提交改动 (git commit -m 'feat: add amazing feature')
  4. 推送到分支 (git push origin feature/amazing-feature)
  5. 开启 Pull Request

请确保你的代码:

  • ✅ 通过 ESLint 检查
  • ✅ 符合代码规范
  • ✅ 包含适当的注释
  • ✅ 通过所有测试

详细规范请查看 Git 提交规范代码开发规范

📄 许可证

MIT License - 详见 LICENSE 文件

👥 团队

  • 产品经理 - 产品设计与需求管理
  • 前端工程师 - UI/UX 实现
  • 后端工程师 - API 与数据库
  • 设计师 - 视觉与交互设计

🙏 致谢

感谢所有为本项目做出贡献的开发者!


Let's make every Vibe last in the universe! 🪩

About

No description, topics, or website provided.
896.00 KiB
0 forks0 stars1 branches0 TagREADMEMIT license
Language
Vue77.1%
TypeScript10.6%
CSS2%
JavaScript0.3%
Others10%