GitHub与IDEA本地交互

1.Git版本管理工具

---

Git版本管理工具为使用GitHub的前置条件，请勿省略！

1.1 Git介绍

下图是 Git 与提交有关的三个命令对应的操作：
Add 命令：把文件从 IDE 的工作目录添加到本地仓库的 stage 区（暂存区）。
Commit 命令：把 stage 区的暂存文件提交到当前分支的仓库，并清空 stage 区。
Push 命令：把本地仓库的提交同步到远程仓库。

所以Git要遵循这三步原则：

[Add] -> [Commit] -> [Push] ->OK~

其中 Add 操作在部分情况下可以省略，譬如：暂存区(stage)中已经包含该文件的情况下，可跳过步骤，直接进行 Commit 和 Push 操作。否则，Add 操作为必须操作！

1.1 下载安装Git

Windows版本下载地址：https://git-scm.com/download/win

安装一路默认下来就好，安装位置可以改一下。

1.2 IDEA中配置Git

//IDEA中:
File -> Settings -> Version Control -> Git
//路径:
[Git安装目录]\bin\git.exe

1.3 IDEA中配置GitHub账户关联

新版 IDEA 点击 “Add Account” 之后，会跳转到网页来关联 GitHub 账户，而不再是 IDEA 操作界面弹出 GitHub 用户登录窗口来关联了。（这里默认大家都有GitHub账户了）

TIPS：过程中会发生 could not kickstart handshaking 即无法与 GitHub 账户握手的情况。

这是因为网络问题，选中账户点击右侧的 - 移除账户，此时该窗口右上角会出现 Reset 的按钮，点击按钮刷新用户，直到可以连接到账户为止。如果懒得弄就科学上网吧。😂

2. 在GitHub上创建仓库

---

GitHub网址：GitHub.com点击跳转

第5点举例说明：
比如开发的项目是maven项目的话，选择maven即可，git在上传的时候会自动分辨哪些是不需要上传（与项目无关）的文件。

3. 将本地项目上传到GitHub上

---

3.1 通过 Git 命令行上传

参考资料：Git官方说明文档：https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes
提示：页面的左侧可以选择语言

先cd进入创建好的本地项目的文件夹下，然后执行如下Git命令：

## 在GitHub创建仓库时没有添加README文件，先创建README.md文件
$ touch README.md

## Git初始化
$ git init
说明：当前目录执行git初始化，在当前目录中添加一个.git文件夹来存储一些git数据

## 添加所有文件到暂存区
$ git add *

## 将暂存区内容提交到本地仓库
$ git commit -m "项目本地仓库上传"

## 连接远程仓库(SSH和HTTPS方式都行)
## git remote add origin git@github.com:[GitHubID]/[ProjectName.git]
##例如：
$ git remote add origin git@github.com:zhangsan/GitHubUpload.git

## 提交到远程仓库
$ git push -u origin master
说明：
git push 将当前分支推送至远程同名分支
git push origin [branch-name] 推送本地某分支至远程某分支
git push -u origin [branch-name] 推送本地某分支至远程某分支，并跟踪

3.2 通过 IDEA 上传

---

新建一个 Project ，名字随意，这里叫 “GitHubUpload”

3.2.1 创建本地Git仓库

VCS -> Import into Version Control -> Create Git Repository

然后选中你的项目文件，点击OK即可。

这就是之后的样子，可以看到 GitHubUpload.iml 是红色的就代表创建本地 Git 仓库成功了~😄

3.2.2 上传本地项目到GitHub

VCS -> Import into Version Control -> Share Project On GitHub

Repository name：GitHub要显示的项目（仓库名）。不要修改
Remote：仓库代名词，指向项目所在GitHub服务器的地址。默认为 origin ，可修改。
Description：GitHub 上项目的描述

完成之后，点击 Share 即可上传到 GitHub。

我们打开自己的 GitHub 的 Repository 界面可以看到项目已经上传成功了！

不过打开项目后，界面却是这样的。

原因是，我们的项目中没有可以显示的内容，毕竟我们上传的是一个空的项目😂。

解决方案：

1. 项目建好后，直接在项目路径下新建一个 README.md ，即可解决问题。很容易，所以不做演示了。
2. 在我们已经上传一个空的项目之后，我们可以再在项目路径下新建一个 README.md ，然后将这个文件上传到我们的 GitHub 项目里，即将本地文件同步到 GitHub 项目里。

方法2是接下来是演示步骤，重点！

首先，在项目里新建一个README.md 文件(与 src 文件夹同级)。
会弹出一个提示问你是否把新建的文件添加到本地 Git ，如图：

点击Add即可。

打开文件随意写点内容：

将文件添加到 Git 中：

先右键点击 README.md 文件 -> Git -> Add
然后右键点击 README.md 文件 -> Git -> Commit File

接下来把文件同步到 GitHub ，也就是Push一下。

显示上传成功，打开 GitHub 中的项目看看吧~

果然上传成功了！😄

其他文件也同样上传，举一反三即可~😄

4. 将GitHub项目clone到IDEA中

---

在GitHub新建一个项目，并复制项目链接：

打开 idea 同步项目：



这样就导入成功了。

---

接下来，如果 GitHub 托管的项目更新了，我们就需要更新到本地了：

1.对 GitHub 项目中的 README.md 进行修改：

2.操作同步到 idea 本地项目：

[IDEA项目名右键] -> Git -> Repository -> Pull

点击确定即可。效果如下：

更新成功了~😄

5.TIPS

---

5.1 关于IDEA中文件名颜色的含义介绍

红色：该文件未被 Git 追踪，即未被提交到 GitHub 仓库中。

蓝色：已经是 GitHub 仓库中的文件，而且还有修改(在本地)。

白色：已经是 GitHub 仓库中的文件，但是未被修改(在本地)。

绿色：已经进入暂存区(Add)，但是还没有被提交(Commit & Push)

黄色：版本控制已忽略文件，即被 gitignore 的文件。比如 runtime 文件，意思是不用git上去的文件。

详见:
Settings -> Version Control -> File Status Colors

---

随时补充。。。。。。。。。。。。。。。。。。。