跟我學 “Linux” 小程式 Web 版開發(一):初始化

Bestony發表於2020-02-02

“Linux” 小程式是 Linux 中國在 2019 年 2 月(恰恰是去年春節)釋出的小程式,該小程式採用眾包模式,對著名的 TLDR 專案中的 Linux 命令示例進行了翻譯,並通過微信小程式的形式展現。在 2020 年的春節,我們面向更多的 PC 端使用者,開放了 Web 版的 Linux 命令查詢。Web 版和小程式版資料同步,讓你在使用桌面計算機時也可以進行命令查詢。

從今天起,我們將在 Linux 中國官網和公眾號上,連載 TL;DR Web 應用開發背後的故事。接下來,請看來自開發 gg 的文章。

背景描述

Linux 中國曾在過去的一年開發和執行了一箇中國版 TL;DR 客戶端。不過當時做的版本是小程式的版本,一直以來,受限於小程式·雲開發沒有 Web SDK ,因此無法將應用能力遷移到更多的平臺上。剛好最近雲開發提供了 Web SDK,並已經逐步成熟,於是我們便可以藉此機會,將業務實現 PC 化,服務更多人群。

在開發出初步的版本之後,我們決定以這個專案作為範例,將我們開發經驗分享給大家,大家可以參考開發自己的雲應用。

專案設計

在進行專案開發時,先對專案進行了基本的 UI 設計:

主頁

詳情頁

這裡用到的是 balsamiq 的手繪線框圖來完成產品設計,以避免我個人過度追求完美,而讓產品延期遲遲不能上線的問題(這樣的事情在歷史上發生了非常多次)

技術選項

由於需要的是一個前端頁面,因此,在技術選型方面,幾乎沒有太多的異議。使用最為熟悉的技術棧來完成。

  • 前端框架:Vue
  • 路由器:Vue Router
  • CSS 框架:Vuetify.js

映象配置

因為身處國內, npm 的速度必然不太好,因此需要進行相應的映象設定,確保 npm 和 yarn 在安裝依賴。這裡使用的是騰訊雲提供的映象。

# Npm 設定
npm config set registry http://mirrors.cloud.tencent.com/npm/

# yarn 設定
yarn config set registry http://mirrors.cloud.tencent.com/npm/ -g

初始化 Vue 專案

首先,需要安裝 Vue CLI,以進行專案的生成,這裡我已經完成安裝,就不再贅述。(Vue CLI 的安裝教程點選這裡

執行如下命令初始化專案:

vue create tldr

等待其完成安裝以後,進入專案,並啟動專案。

cd tldr
yarn serve

隨即,可以在瀏覽器中訪問 localhost:8080 檢視專案:

預覽

記得引入 git 做版本控制,文章裡就不介紹了。沒意思。

安裝 Vue Router

在完成 Vue 專案的初始化以後,接下來需要進行 Vue Router 的配置了。

Vue Router 的配置在引入了 Vue 3 以後,顯得非常的簡單,直接執行如下命令即可:

vue add router

執行過程中,會問你是否需要啟用 History Mode,根據需要選取,我使用的是 History Mode。

設定完成以後,儲存並重啟 Vue 的開發伺服器,你會在預覽中看到 Router 新增的 “Home” 和 “About”。

安裝 Vuetify.js

接下來安裝的是 Vuetify.js ,由於框架提供了相應的支援,因此在開發時也非常簡單,只需要執行如下命令就可以完成初始化。

vue add vuetify

會問你選擇那種預設,直接使用 Default 即可。

儲存並重啟開發伺服器,你會看到這樣的介面,則說明配置完成。

部署測試應用

在進行下一步開發的時候,需要先進行一下專案的部署,從而獲得一個測試的域名,方便後續的開發。

這裡專案的開發我並沒有使用雲開發自己的 Web 託管 (因為我們不是按量付費套餐,所以沒有辦法開啟),而是使用了 Now.sh 的,這裡就不再過多贅述。

引入雲開發 SDK

雲開發提供了 Web SDK ,可以通過 npm 安裝,並引用。

執行如下命令來安裝:

yarn add tcb-js-sdk

安裝完成後,在 main.js 中引入 tcb,並通過修改 Vue 的原型來實現掛載 Vue。

import Vue from 'vue'
import App from './App.vue'
import router from './router'
import vuetify from './plugins/vuetify';
const tcb = require('tcb-js-sdk')  // 新增的引入 TCB

Vue.config.productionTip = false

Vue.prototype['$tcb'] = tcb.init({ // 新增的修改原型
    env: 'prod-2c59c7'             // 新增的修改原型
})                                 // 新增的修改原型

new Vue({
  router,
  vuetify,
  render: h => h(App)
}).$mount('#app')

這樣就可以在應用執行的整個週期中使用 this.$tcb 來呼叫雲開發的相關邏輯。

總結

在完成了專案的初始化以後,回過頭來看一看這在初始化專案過程中,都做了哪些事情。

  1. 配置 npm 映象,以確保 Node 包的安裝速度
  2. 使用 Vue CLI 來初始化專案
  3. 安裝 Vue Router & Vuetify.js
  4. 部署應用
  5. 安裝 tcb-js-sdk 以呼叫雲開發資料

請期待本系列的下一篇關於介面開發的文章。

跟我學 “Linux” 小程式 Web 版開發(一):初始化

訂閱“Linux 中國”官方小程式來檢視

相關文章