前言

可能一进来大部分人都会觉得,为什么还会有人重复造轮子,GitHub 第三方客户端都已经烂大街啦。确实,一开始我自己也是这么觉得的,也问过自己是否真的有意义再去做这样一个项目。思考再三,以下原因也决定了我愿意去做一个让自己满意的 GitHub 第三方客户端:

  • 对于时常关注 GitHub Trending 列表的笔者来说,迫切需要一个更简单的方式随时随地去跟随 GitHub 最新的技术潮流;

  • 已有的一些 GitHub 小程序客户端颜值与功能并不能满足笔者的要求;

  • 听说 iOS 开发没人要了,掌握一门新的开发技能,又何尝不可?

  • 其实也没那么多原因,既然想做,那就去做,开心最重要。

  • 60s测试:你是否适合转型人工智能?

    https://edu.csdn.net/topic/ai30?utm_source=csdn_bw

Gitter

  • GitHub:https://github.com/huangjianke/Gitter,可能是目前颜值最高的 GitHub 小程序客户端,欢迎 Star

  • 数据来源:GitHub API v3(https://developer.github.com/v3/)

目前实现的功能有:

  • 实时查看 Trending

  • 显示用户列表

  • 仓库和用户的搜索

  • 仓库:详情展示、README.md 展示、Star/Unstar、Fork、Contributors 展示、查看仓库文件内容

  • 开发者:Follow/Unfollow、显示用户的 followers/following

  • Issue:查看 issue 列表、新增 issue、新增 issue 评论

  • 分享仓库、开发者

  • ...

Gitter 的初衷并不是想把网页端所有功能照搬到小程序上,因为那样的体验并不会很友好,比如说,笔者自己也不想在手机上阅读代码,那将会是一件很痛苦的事。

在保证用户体验的前提下,让用户用更简单的方式得到自己想要的,这是一件有趣的事。

探索篇

技术选型

第一次觉得,在茫茫前端的世界里,自己是那么渺小。

当决定去做这个项目时,就开始了马不停蹄的技术选型,但摆在自己面前的选择是那么多,也不得不感慨,前端的世界,真的很精彩。

  • 原生开发:基本上一开始就放弃了,开发体验很不友好;

  • WePY:之前用这个框架已经开发过一个小程序,诗词墨客,不得不说,坑是真多,用过的都知道;

  • mpvue:用 Vue 的方式去开发小程序,个人觉得文档并不是很齐全,加上近期维护比较少,可能是趋于稳定了?

  • Taro:用 React 的方式去开发小程序,Taro 团队的小伙伴维护真的很勤快,也很耐心地解答大家疑问,文档也比较齐全,开发体验也很棒,还可以一键生成多端运行的代码(暂没尝试)

货比三家,经过一段时间的尝试及踩坑,综合自己目前的能力,最终确定了 Gitter 的技术选型:

Taro + Taro UI + Redux + 云开发 Node.js

页面设计

其实,作为一名 Coder,曾经一直想找个 UI 设计师妹子做老婆(肯定有和我一样想法的 Coder),多搭配啊。

话回正题,没有设计师老婆页面设计怎么办?毕竟笔者想要的是一款高颜值的 GitHub 小程序。

嗯,不慌,默默拿出了笔者沉寂已久的 Photoshop 和 Sketch。不敢说自己的设计能力如何,Gitter 的设计至少是能让笔者自己心情愉悦的,倘若哪位设计爱好者想对 Gitter 的设计进行改良,欢迎欢迎,十二分的欢迎!

开发篇

Talk is cheap. Show me the code.

作为一篇技术性文章,怎可能少得了代码。

在这里主要写写几个踩坑点,作为一个前端小白,相信各位读者均是笔者的前辈,还望多多指教!

Trending

进入开发阶段没多久,就遇到了第一个坑。GitHub 居然没有提供 Trending 列表的 API !

也没有过多去想 GitHub 为什么不提供这个 API,只想着怎么去尽快填好这个坑。一开始尝试使用 Scrapy 写一个爬虫对网页端的 Trending 列表信息进行定时爬取及存储供小程序端使用,但最终还是放弃了这个做法,因为笔者并没有服务器与已经备案好的域名,小程序的云开发也只支持 Node.js 的部署。

开源的力量还是强大,最终找到了 github-trending-api,稍作修改,成功部署到小程序云开发后台,在此,感谢原作者的努力。

  • 爬取 Trending Repositories

async function fetchRepositories({

language = '',

since = 'daily',

} = {}) {

const url = `${GITHUB_URL}/trending/${language}?since=${since}`;

const data = await fetch(url);

const $ = cheerio.load(await data.text());

return (

$('.repo-list li')

.get()

// eslint-disable-next-line complexity

.map(repo => {

const $repo = $(repo);

const title = $repo

.find('h3')

.text()

.trim();

const relativeUrl = $repo

.find('h3')

.find('a')

.attr('href');

const currentPeriodStarsString =

$repo

.find('.float-sm-right')

.text()

.trim() || /* istanbul ignore next */ '';

const builtBy = $repo

.find('span:contains("Built by")')

.parent()

.find('[data-hovercard-type="user"]')

.map((i, user) => {

const altString = $(user)

.children('img')

.attr('alt');

const avatarUrl = $(user)

.children('img')

.attr('src');

return {

username: altString

? altString.slice(1)

/* istanbul ignore next */ null,

href: `${GITHUB_URL}${user.attribs.href}`,

avatar: removeDefaultAvatarSize(avatarUrl),

};

})

.get();

const colorNode = $repo.find('.repo-language-color');

const langColor = colorNode.length

? colorNode.css('background-color')

: null;

const langNode = $repo.find('[itemprop=programmingLanguage]');

const lang = langNode.length

? langNode.text().trim()

/* istanbul ignore next */ null;

return omitNil({

author: title.split(' / ')[0],

name: title.split(' / ')[1],

url: `${GITHUB_URL}${relativeUrl}`,

description:

$repo

.find('.py-1 p')

.text()

.trim() || /* istanbul ignore next */ '',

language: lang,

languageColor: langColor,

stars: parseInt(

$repo

.find(`[href="${relativeUrl}/stargazers"]`)

.text()

.replace(',', '') || /* istanbul ignore next */ 0,

10

),

forks: parseInt(

$repo

.find(`[href="${relativeUrl}/network"]`)

.text()

.replace(',', '') || /* istanbul ignore next */ 0,

10

),

currentPeriodStars: parseInt(

currentPeriodStarsString.split(' ')[0].replace(',', '') ||

/* istanbul ignore next */ 0,

10

),

builtBy,

});

})

);

}

  • 爬取 Trending Developers

async function fetchDevelopers({ language = '', since = 'daily' } = {}) {

const data = await fetch(

`${GITHUB_URL}/trending/developers/${language}?since=${since}`

);

const $ = cheerio.load(await data.text());

return $('.explore-content li')

.get()

.map(dev => {

const $dev = $(dev);

const relativeUrl = $dev.find('.f3 a').attr('href');

const name = getMatchString(

$dev

.find('.f3 a span')

.text()

.trim(),

/^\((.+)\)$/i

);

$dev.find('.f3 a span').remove();

const username = $dev

.find('.f3 a')

.text()

.trim();

const $repo = $dev.find('.repo-snipit');

return omitNil({

username,

name,

url: `${GITHUB_URL}${relativeUrl}`,

avatar: removeDefaultAvatarSize($dev.find('img').attr('src')),

repo: {

name: $repo

.find('.repo-snipit-name span.repo')

.text()

.trim(),

description:

$repo

.find('.repo-snipit-description')

.text()

.trim() || /* istanbul ignore next */ '',

url: `${GITHUB_URL}${$repo.attr('href')}`,

},

});

});
}

  • Trending 列表云函数

// 云函数入口函数
exports.main = async (event, context) => {
  const { type, language, since } = event
  let res = null;
  let date = new Date()
  if (type === 'repositories') {
    const cacheKey = `repositories::${language || 'nolang'}::${since ||
    'daily'}`;
    const cacheData = await db.collection('repositories').where({
      cacheKey: cacheKey
    }).orderBy('cacheDate', 'desc').get()
    if (cacheData.data.length !== 0 &&
      ((date.getTime() - cacheData.data[0].cacheDate)  < 1800 * 1000)) {
      res = JSON.parse(cacheData.data[0].content)
    } else {
      res = await fetchRepositories({ language, since });
      await db.collection('repositories').add({
        data: {
          cacheDate: date.getTime(),
          cacheKey: cacheKey,
          content: JSON.stringify(res)
        }
      })
    }
  } else if (type === 'developers') {
    const cacheKey = `developers::${language || 'nolang'}::${since || 'daily'}`;
    const cacheData = await db.collection('developers').where({
      cacheKey: cacheKey
    }).orderBy('cacheDate', 'desc').get()
    if (cacheData.data.length !== 0 &&
      ((date.getTime() - cacheData.data[0].cacheDate)  < 1800 * 1000)) {
      res = JSON.parse(cacheData.data[0].content)
    } else {
      res = await fetchDevelopers({ language, since });
      await db.collection('developers').add({
        data: {
          cacheDate: date.getTime(),
          cacheKey: cacheKey,
          content: JSON.stringify(res)
        }
      })
    }
  }
  return {
    data: res
  }
}

Markdown 解析

这是一个大坑。

在做技术调研的时候,发现小程序端 Markdown 解析主要有以下方案:

  • wxParse:作者最后一次提交已是两年前了,经过自己的尝试,也确实发现已经不适合如 README.md 的解析

  • wemark:一款很优秀的微信小程序 Markdown 渲染库,但经过笔者尝试之后,发现对 README.md 的解析并不完美

  • towxml:目前发现是微信小程序最完美的 Markdown 渲染库,已经能近乎完美地对 README.md 进行解析并展示

在 Markdown 解析这一块,最终采用的也是 towxml,但发现在解析性能这一块,目前并不是很优秀,对一些比较大的数据解析也超出了小程序所能承受的范围,还好贴心的作者(sbfkcel)提供了服务端的支持,在此感谢作者的努力!

  • Markdown 解析云函数

const Towxml = require('towxml');
const towxml = new Towxml();

// 云函数入口函数
exports.main = async (event, context) => {
  const { func, type, content } = event
  let res
  if (func === 'parse') {
    if (type === 'markdown') {
      res = await towxml.toJson(content || '', 'markdown');
    } else {
      res = await towxml.toJson(content || '', 'html');
    }
  }
  return {
    data: res
  }
}

  • markdown.js 组件

import Taro, { Component } from '@tarojs/taro'
import PropTypes from 'prop-types'
import { View, Text } from '@tarojs/components'
import { AtActivityIndicator } from 'taro-ui'

import './markdown.less'

import Towxml from '../towxml/main'

const render = new Towxml()

export default class Markdown extends Component {
  static propTypes = {
    md: PropTypes.string,
    base: PropTypes.string
  }

static defaultProps = {
    md: null,
    base: null
  }

constructor(props) {
    super(props)
    this.state = {
      data: null,
      fail: false
    }
  }

componentDidMount() {
    this.parseReadme()
  }

parseReadme() {
    const { md, base } = this.props
    let that = this
    wx.cloud.callFunction({
      // 要调用的云函数名称
      name: 'parse',
      // 传递给云函数的event参数
      data: {
        func: 'parse',
        type: 'markdown',
        content: md,
      }
    }).then(res => {
      let data = res.result.data
      if (base && base.length > 0) {
        data = render.initData(data, {base: base, app: this.$scope})
      }
      that.setState({
        fail: false,
        data: data
      })
    }).catch(err => {
      console.log('cloud', err)
      that.setState({
        fail: true
      })
    })
  }

render() {
    const { data, fail } = this.state
    if (fail) {
      return (
        <View className='fail' onClick={this.parseReadme.bind(this)}>
          <Text className='text'>load failed, try it again?</Text>
        </View>
      )
    }
    return (
      <View>
      {
        data ? (
          <View>
            <import src='../towxml/entry.wxml' />
            <template is='entry' data='{{...data}}' />
          </View>
        ) : (
          <View className='loading'>
            <AtActivityIndicator size={20} color='#2d8cf0' content='loading...' />
          </View>
        )
      }
      </View>
    )
  }
}

Redux

其实,笔者在该项目中,对 Redux 的使用并不多。一开始,笔者觉得所有的接口请求都应该通过 Redux 操作,后面才发现,并不是所有的操作都必须使用 Redux,最后,在本项目中,只有获取个人信息的时候使用了 Redux。

// 获取个人信息
export const getUserInfo = createApiAction(USERINFO, (params) => api.get('/user', params))

export function createApiAction(actionType, func = () => {}) {
  return (
    params = {},
    callback = { success: () => {}, failed: () => {} },
    customActionType = actionType,
  ) => async (dispatch) => {
    try {
      dispatch({ type: `${customActionType  }_request`, params });
      const data = await func(params);
      dispatch({ type: customActionType, params, payload: data });

callback.success && callback.success({ payload: data })
      return data
    } catch (e) {
      dispatch({ type: `${customActionType  }_failure`, params, payload: e })

callback.failed && callback.failed({ payload: e })
    }
  }
}

getUserInfo() {
    if (hasLogin()) {
      userAction.getUserInfo().then(()=>{
        Taro.hideLoading()
        Taro.stopPullDownRefresh()
      })
    } else {
      Taro.hideLoading()
      Taro.stopPullDownRefresh()
    }
  }

const mapStateToProps = (state, ownProps) => {
  return {
    userInfo: state.user.userInfo
  }
}
export default connect(mapStateToProps)(Index)

export default function user (state = INITIAL_STATE, action) {
  switch (action.type) {
    case USERINFO:
      return {
        ...state,
        userInfo: action.payload.data
      }
    default:
      return state
  }
}

目前,笔者对 Redux 还是处于一知半解的状态,学习的路还很长。

结语篇

当 Gitter 第一个版本通过审核的时候,心情是很激动的,就像自己的孩子一样,看着他一点一点地长大,笔者也很享受这样一个项目从无到有的过程,在此,对那些帮助过笔者的人一并表示感谢。

当然,目前功能和体验上可能有些不大完善,也希望大家能提供一些宝贵的意见,Gitter 走向完美的路上希望有你!

最后,希望 Gitter 小程序能对你有所帮助!

另附项目源码:https://github.com/huangjianke/Gitter

作者简介:huangjianke,高级iOS开发/前端开发工程师,五年开发经验。

声明:本文为作者投稿,未经允许请勿转载。


想找人聊聊时下火热的开源项目?

开源方面攒下的困惑亟待解答?

找不到开源的组织?

欢迎加入我们的开源开发者群!

在线等一个拥抱开源的你!

 热

人工智能学习路线+实战训练

https://edu.csdn.net/topic/ai30?utm_source=csdn_bw

 推 荐 

☞ 华为小米入场,能拯救乐视互联网电视挖的坑吗?

☞ Android 设备正在“绞杀”密码!

☞ 如何用令人拍案称奇的强化学习玩小游戏?

☞ 为什么程序员下班后只关显示器从不关电脑?

☞ 云评测 | OpenStack智能运维解决方案 @文末有福利!

☞ 指纹锁就安全了?防火防盗还得防AI

☞ 当恐怖组织哈马斯玩起了加密货币, 世界又少了多少伟大的灵魂……

☞ 月入5万,程序员夫人们过上"贵妇"生活了吗?

print_r('点个好看吧!');
var_dump('点个好看吧!');
NSLog(@"点个好看吧!");
System.out.println("点个好看吧!");
console.log("点个好看吧!");
print("点个好看吧!");
printf("点个好看吧!\n");
cout << "点个好看吧!" << endl;
Console.WriteLine("点个好看吧!");
fmt.Println("点个好看吧!");
Response.Write("点个好看吧!");
alert("点个好看吧!")
echo "点个好看吧!"

点击阅读原文,输入关键词,即可搜索您想要的 CSDN 文章。

喜欢就点击“好看”吧!

如何从零开始整一个高颜值 GitHub 小程序客户端?相关推荐

  1. Gitter - 高颜值GitHub小程序客户端诞生记

    0. 前言 嗯,可能一进来大部分人都会觉得,为什么还会有人重复造轮子,GitHub第三方客户端都已经烂大街啦.确实,一开始我自己也是这么觉得的,也问过自己是否真的有意义再去做这样一个项目.思考再三,以 ...

  2. Gitter - 高颜值GitHub小程序客户端诞生记 1

    0. 前言 嗯,可能一进来大部分人都会觉得,为什么还会有人重复造轮子,GitHub第三方客户端都已经烂大街啦.确实,一开始我自己也是这么觉得的,也问过自己是否真的有意义再去做这样一个项目.思考再三,以 ...

  3. 分享一个高质量的 小程序UI框架

    先上ui 地址 github.com/weilanwl/Co- 先看这里,我感觉这个ui开源作者肯定是一位ui设计师,介绍就已经很高颜值了,下面我们来观看一下这个ui框架,这个ui框架和其他ui框架不 ...

  4. 高颜值微信小程序 UI 组件库!

    Vant Weapp Vant 是一个轻量.可靠的移动端组件库,由有赞于 2017 年开源. Github(⭐️ 16.5k):github.com/youzan/vant- iView Weapp ...

  5. 使用Python实现一个七牛GUI小程序客户端

    经常使用有道云笔记的MarkDown功能来写文章或者记录日志难免会向文章中插入图片,可是有道云笔记的这功能是收费的,因此用python开发一个GUI小工具可以可以帮我把图片上传到七牛cdn,然后我就可 ...

  6. flutter listview 滚动到底部_??一个高颜值Flutter版WanAndroid客户端

    1. 前言 ❝ 项目地址: https://github.com/xfhy/WanAndroid-Flutter ❞ 前段时间抽了点业余时间学了点Flutter入门,打算写个简单项目练练手.说实话,只 ...

  7. 麻省理工学院计算机博士奖学金,NWU这位高颜值学霸小姐姐,获麻省理工博士全额奖学金录取!...

    原标题:NWU这位高颜值学霸小姐姐,获麻省理工博士全额奖学金录取! 她是公认的"高颜值学霸小姐姐" 170cm+的身高 笑起来天都会放晴 托福100+GRE320+ 本科毕业的她 ...

  8. 码出一个高颜值原生折线图(新增柱状图、环形图)

    一:介绍 在项目中遇到数据展示需求时,往往会通过,以列表的形式展示出数据或者以表格的形式展示.但是并不能直观的观察数据的变化,如果通过图表的形式来展示,就可以更快捷的获取到数据变化情况. 图表展示的方 ...

  9. 从零开始构建一个高可靠的RabbitMQ镜像集群

    从零开始构建一个高可靠的RabbitMQ镜像集群 1.集群环境节点规划如表所示: 1 集群构建 1.停止MQ服务,首先停止3个节点的服务的命令如下: service rabbitmq-server s ...

最新文章

  1. Algs4-1.3.33一个双向队列Deque-双向链表实现
  2. java 画图覆盖_请教如何在java画图中不覆盖原来的画图???
  3. charles抓app包教程_charles关于手机APP抓包
  4. Java单例模式的七种写法
  5. com.android.phone已停止运行怎么解决方法,com.android.phone已停止运行怎么解决
  6. CPA00 01 02
  7. window10设置文件夹备注
  8. 【HDU4312】Meeting point-2(切比雪夫距离和曼哈顿距离的转化+前缀和后缀和去绝对值)
  9. intel fortran免费版安装
  10. HenCoder Android开发进阶系列学习笔记
  11. 【文本识别】CRNN
  12. Halcon 3D 计算3D模型的3D表面法线
  13. 小米4刷魅族系统后无服务器,小米4线刷魅族Flyme OS系统的教程_小米4 Flyme OS刷机包...
  14. 计算广告学-学习笔记
  15. LOCAL_PRIVILEGED_MODULE 详解(3)
  16. VBA基础语法:类型转换函数
  17. IDEA一直在indexing的解决方案
  18. echart 饼图数据显示
  19. java 开发服务器
  20. 打开相机拍照或从相册中选择照片

热门文章

  1. 两台电脑网线传输文件教程
  2. ubuntu 16.04 安装ros kinetic
  3. 计算机系统层次中 从上层,在计算机系统层次结构中下层是上层的上层是下层的一个.ppt...
  4. rust笔记5结构体
  5. 剑指Offer之二叉树与双向链表
  6. flask(五) cookie 和session
  7. 加工食品和饮料防腐剂行业调研报告 - 市场现状分析与发展前景预测
  8. 2021-2025年中国电动陶瓷球阀行业市场供需与战略研究报告
  9. 2021-2025年中国厨房橱柜行业市场供需与战略研究报告
  10. Serverless 崛起背后的五大挑战