在GitHub Pages中快速部署React项目

为了做一个自己方便使用的工具类网页,第一反应是把它部署在GitHub pages上,然后google之后马上发现了react-gh-pages这个建立在create-react-app基础上针对GitHub Pages自动化发布工具,非常方便的实现了在GitHub Pages上的推送和部署功能。

但是它的文档上的使用说明并不是针对免费账号和个人项目的,在使用和配置上与它自己的描述有一些出入,我是在issue里面找到了解决的办法,现在把使用流程在下面分享下:

  1. 准备工作,创建一个以 {username}.github.io为名称的项目,GitHub会默认把这个项目当作GitHub Pages的目录,默认的地址为 {username}.github.io, 其中username是你GitHub的昵称,请自行替换。

  2. 使用create-react-app创建一个React项目;

// 本地项目可以随便命名,这里以github-pages为例
create-react-app  github-pages
  1. 安装一个名为gh-pages的依赖;
$ cd github-pages
$ npm install gh-pages --save-dev
  1. 打开package.json,在scripts项中增加推送部署配置
"scripts": {
  //...
  "predeploy": "npm run build",
  "deploy": "gh-pages -d build -b master"
}

注:文档上这一步的deploy命令与此处不同,它的命令会新建一个gh-pages分支并将编译生成的代码推送到该分支上,但在GitHub项目的setting -> options -> Github Pages设置项下可以看到,个人用户的页面只能部署在master分支上,见下图:

  1. 本地git配置;
$ git init
$ git git remote add origin https://github.com/{username}/{username}.github.io.git
  1. 执行构建推送命令:
$ npm deploy

当看到命令行结尾出现如下输出时,代表构建完毕的项目已经推送到GitHub项目的master分支:


现在在浏览器输入{username}.github.io地址应该就能看到部署好的网页,如下图所示:

  1. 将本地代码推送到当前项目的其他分支
// 我使用的是dev分支
git checkout -b dev
git add *
git commit "......"
git push origin dev
  1. 后续代码更新之后,再次执行npm deploy即可部署完毕,然后将更新的代码同步到创建的分支即可,非常的方便。

参考项目地址:https://github.com/gitname/react-gh-pages

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,242评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,769评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,484评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,133评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,007评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,080评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,496评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,190评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,464评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,549评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,330评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,205评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,567评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,889评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,160评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,475评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,650评论 2 335