Skip to content

937bb/937bbAPI_web

Repository files navigation

📡 937bbAPI 导航站

最全、最易用的免费API接口导航站

Nuxt 3 Vue 3 Tailwind CSS TypeScript

🌟 项目介绍

937bbAPI 是一个现代化的API接口导航网站,旨在为开发者提供便捷的API搜索和使用体验。项目采用前沿的前端技术栈构建,具有响应式设计,支持PC和移动端访问。

✨ 功能特性

  • 🔍 强大的API搜索:快速找到您需要的API接口
  • 📱 响应式设计:完美适配各种设备尺寸
  • 🎨 现代化UI:简洁美观的用户界面
  • 极速加载:基于Nuxt 3的快速渲染
  • 🔄 实时监控:API状态实时监控
  • 📊 使用统计:详细的API调用统计
  • 🔒 用户认证:安全的用户认证与授权
  • 🌍 多语言支持:国际化支持(开发中)

🛠️ 技术栈

  • 前端框架: Nuxt 3 + Vue 3
  • UI组件: Headless UI + Heroicons
  • 样式: Tailwind CSS 3
  • 构建工具: Vite
  • 编程语言: TypeScript
  • 代码规范: ESLint + Prettier
  • 版本控制: Git

🚀 快速开始

环境要求

  • Node.js >= 18.0.0
  • pnpm >= 8.0.0

安装依赖

# 安装依赖
pnpm install

开发环境

# 启动开发服务器
pnpm dev

生产环境

# 构建生产版本
pnpm build

# 预览生产版本
pnpm preview

📁 项目结构

├── .nuxt/                  # Nuxt 自动生成的文件
├── .output/               # 构建输出目录
├── .vscode/               # VS Code 配置
├── assets/                # 静态资源
│   ├── css/               # 全局样式
│   └── images/            # 图片资源
├── components/            # 公共组件
│   ├── layout/            # 布局组件
│   ├── ui/                # UI 基础组件
│   └── icons/             # 图标组件
├── composables/           # 组合式函数
├── content/               # 内容文件(如 Markdown)
├── layouts/               # 布局文件
│   └── default.vue        # 默认布局
├── middleware/            # 中间件
├── node_modules/          # 项目依赖
├── pages/                 # 页面组件
│   ├── api/               # API 相关页面
│   ├── index.vue          # 首页
│   └── [...slug].vue      # 动态路由
├── plugins/               # 插件
├── public/                # 静态文件(直接复制到根目录)
├── server/                # 服务端代码
│   ├── api/               # API 路由
│   └── middleware/        # 服务端中间件
├── static/                # 静态资源(直接映射到根路径)
├── stores/                # 状态管理
├── types/                 # TypeScript 类型定义
├── utils/                 # 工具函数
├── .editorconfig          # 编辑器配置
├── .env.development       # 开发环境变量
├── .env.production        # 生产环境变量
├── .eslintrc.js           # ESLint 配置
├── .gitignore             # Git 忽略文件
├── app.vue                # 应用入口
├── nuxt.config.ts         # Nuxt 配置文件
├── package.json           # 项目配置
├── pnpm-lock.yaml         # 依赖版本锁文件
├── README.md              # 项目说明
└── tsconfig.json          # TypeScript 配置

## ⚙️ 环境变量配置

使用`.env.development`(开发环境)或 `.env.production`(生产环境),然后修改相应配置:

```env
# 基础配置
VITE_BASE_URL=你的API基础地址
VITE_SITE_NAME=937bbAPI
VITE_ICP=你的ICP备案号
VITE_ICP_URL=备案查询链接
VITE_AUTHOR=你的名字
VITE_USER_NODE_ENV=development

🛠️ 开发指南

创建新页面

  1. pages 目录下创建新的 .vue 文件
  2. 使用以下模板开始编写:
<template>
  <div>
    <!-- 页面内容 -->
  </div>
</template>

<script setup>
// 页面逻辑
</script>

<style scoped>
/* 页面样式 */
</style>

添加新组件

  1. components 目录下创建新的组件文件
  2. 使用 defineComponent<script setup> 语法
  3. 在需要的页面中导入并使用

🚀 构建与部署

构建生产版本

# 构建生产版本
pnpm build

# 预览生产版本
pnpm preview

部署

项目支持多种部署方式:

  1. Node.js 服务器:

    pnpm build
    pnpm prod
  2. 静态站点:

    pnpm generate
    # 将 .output/public 目录部署到静态网站托管服务
  3. Docker 部署:

    FROM node:18-alpine
    WORKDIR /app
    COPY . .
    RUN pnpm install --frozen-lockfile
    RUN pnpm build
    CMD ["node", ".output/server/index.mjs"]

🤝 贡献指南

欢迎提交 Issue 和 Pull Request!

  1. Fork 项目
  2. 创建特性分支 (git checkout -b feature/amazing-feature)
  3. 提交更改 (git commit -m 'Add some amazing feature')
  4. 推送到分支 (git push origin feature/amazing-feature)
  5. 开启 Pull Request

👥 贡献者

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

想要成为贡献者?请阅读我们的 贡献指南

🔗 相关项目

📦

API 管理后台

一个功能完整的API管理后台,提供API的创建、管理、监控和权限控制等功能。

📄 许可证

本项目采用 MIT 许可证。

🙏 致谢

  • Nuxt 3 - 直观的 Vue 框架
  • Vue 3 - 渐进式 JavaScript 框架
  • Tailwind CSS - 实用优先的 CSS 框架
  • Vite - 下一代前端工具链
  • TypeScript - JavaScript with syntax for types

📊 项目统计

GitHub stars GitHub forks GitHub watchers License


Made with ❤️ by 937bb

© 2025 937bbAPI. All rights reserved.

About

公益API 前端页面

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors