Skip to content

Commit

Permalink
feat: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
baiwumm committed Jun 24, 2024
1 parent 1fbdf5a commit 60e78cc
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 2 deletions.
76 changes: 74 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,74 @@
## Dream Site
致力于打造程序员的梦中情站
<div align="center">
<img alt="logo" src="./src/public/logo.svg" width="80"/>
<h2>梦中情站</h2>
<p>致力于打造程序员的梦中情站</p>
</div>

## 🪴 项目信息
* 😝 项目预览:https://dream-site.cn/
* 🎯 技术栈:[Nuxt3](https://nuxt.com/)[Vue.js](https://cn.vuejs.org/)[Tailwindcss](https://www.tailwindcss.cn/)[Supabase](https://supabase.com/)[Element-plus](https://element-plus.org/)

## ✨ 特性
* 使用前端最新技术栈开发
* 极快响应、便于开发部署
* 目录结构清晰,轻量级,前后端一体
* 支持多种部署方式,优先推荐 [Vercel](https://vercel.com/)
* 支持暗黑模式
* 支持 `SSR` 渲染,利于 `SEO` 优化

## 💻 演示图

<div style="display:flex;justify-content:space-between;">
<img alt="亮色模式" src="./src/assets/images/light.png" style="width:49%;"/>
<img alt="暗色模式" src="./src/assets/images/dark.png" style="width:49%;"/>
</div>

## 🧑‍💻 项目运行
**环境:Node.js > 18.17**

```powershell
// 克隆项目
git clone https://github.com/baiwumm/dream-site.git
// 安装依赖
pnpm install
// 运行
pnpm dev
```

## ⚙️ Vercel 一键部署
1. `Fork` 本项目,在 `Vercel` 官网点击 `New Project`
2. 点击 `Import Git Repository` 并选择你 fork 的此项目并点击 `import`
3. `PROJECT NAME`自己填,`FRAMEWORK PRESET``Other` 然后直接点 `Deploy` 接着等部署完成即可

<a href="https://vercel.com/dashboard" target="_blank">
<img alt="vercel 部署" src="./src/assets/images/vercel.svg" />
</a>

## ⚙️ Vecel 本地部署
```powershell
// 全局安装 vercel
npm i -g vercel
// 登录
vercel login
// 项目推送
vercel
// 挂载生产
vercel --prod
```
> 具体教程可参考文章:[如何使用 Vercel 托管静态网站](https://baiwumm.com/p/5zzij7bt)
## ✅ TODO
◻️ 首页添加每日一图 `Banner`
◻️ 添加全局资源搜索框
◻️ 支持更多登录方式
◻️ 优化 `UI` 展示
...

## ⭐ Star History

[![Star History Chart](https://api.star-history.com/svg?repos=baiwumm/dream-site&type=Date)](https://star-history.com/#baiwumm/dream-site&Date)
Binary file added src/assets/images/dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions src/assets/images/vercel.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 60e78cc

Please sign in to comment.