You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+80-45Lines changed: 80 additions & 45 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,19 +4,39 @@
4
4
<pstyle="font-weight: 700; font-size: 30px;">Make Your Git Easier</p>
5
5
</div></div>
6
6
7
+
Pretty Git is browser-based git GUI program which supports basic browsing functionalities and several git-related commands.
8
+
Git is a powerful version control system and it is easy to use once you get used to various git commands and its workflow. But For Beginners, it is true that git can be complex to use and it really takes time to apply git workflow to your project at the first time.
9
+
Our team also stucked at this stage when we were beginner git and then started this project to make git usage more easier.
10
+
It's always good starting point to understand git workflow with comprehensive GUI supports.
11
+
we are sure that you will be familiar with git workflow while you using our project.
12
+
13
+
We are always open to get any feedbacks and anyone who wants to contribute this project.
14
+
7
15
# Tested environment
8
16
9
-
- machine: MacOS Ventura 13.3.1, Windows OS 11
10
-
- runtime : node v19.8.1
11
-
- libraries
12
-
- axios : v1.4.0
13
-
- express : v4.18.2
14
-
- pug : v3.0.2
15
-
- nodemon : v2.0.20
16
-
- simple-git: v3.18.0
17
-
- minimatch: v9.0.0
17
+
| machine | version |
18
+
| ---------- | -------------- |
19
+
| MacOS | Ventura 13.3.1 |
20
+
| Windows OS | 11 |
21
+
22
+
| Runtime | version |
23
+
| ------- | ------- |
24
+
| node.js | v19.8.1 |
25
+
26
+
| libraries | version |
27
+
| ---------- | -------- |
28
+
| axios | v1.4.0 |
29
+
| express | v4.18.2 |
30
+
| pug | v3.0.2 |
31
+
| nodemon | v2.0.20 |
32
+
| simple-git | v.3.18.0 |
33
+
| minimatch | v9.0.0 |
18
34
19
-
# Prerequisites
35
+
# Installation
36
+
37
+
## 1. prerequisites
38
+
39
+
### Git config
20
40
21
41
- If you don't have a git, Install git first and then config your git account
22
42
@@ -27,6 +47,8 @@
27
47
git config --global user.name "your name"
28
48
```
29
49
50
+
### Node.js
51
+
30
52
- Install node.js runtime corresponding your machine platform. We highly recommend you to install LTS version.
31
53
- [official node.js site](https://nodejs.org/ko)
32
54
- To run local server in your machine, you need to install 'nodemon' package globally. Follow below command.
@@ -45,16 +67,12 @@
45
67
npm i -g nodemon
46
68
```
47
69
48
-
- Install 'simple-git' npm module.
49
-
50
-
```
51
-
npm i simple-git
52
-
```
70
+
### Chrome browser
53
71
54
72
- Our project doesn't guarantee that it will work on every browser. We recommend you to use chrome browser.
## 2. Download source codes and Install Dependencies
58
76
59
77
1. Clone our repo or Download source files.
60
78
```
@@ -64,23 +82,39 @@
64
82
```
65
83
npm install
66
84
```
67
-
3. Run the file server by typing below command and Enjoy it!
68
85
69
-
```
86
+
# How to run
87
+
88
+
1. First, To run the pretty-git local server, move to the directory path where you clone our project source code.
89
+
<br>
90
+
Then, you can run the server by running below command
91
+
92
+
```bash
70
93
npm run dev
71
94
```
72
95
73
-
<span style="color: orangered;">[Warning]</span> If you already running something on same port, you will see below error.
96
+
If the sever successfully running, you can see this lines in your terminal screen
97
+
98
+
```bash
99
+
[nodemon] 2.0.20
100
+
[nodemon] to restart at any time, enter rs
101
+
[nodemon] watching path(s): *.*
102
+
[nodemon] watching extensions: js,mjs,json
103
+
[nodemon] starting node src/index.js
104
+
Server running on port 3000
105
+
```
106
+
107
+
2. <spanstyle="color: orangered;">[Warning]</span> If you already running something on same port, you will see below error.
74
108
75
109
```
76
110
Emitted 'error' event on Server instance at:
77
-
at emitErrorNT (node:net:1801:8)
78
-
at process.processTicksAndRejections (node:internal/process/task_queues:82:21) {
79
-
code: 'EADDRINUSE',
80
-
errno: -48,
81
-
syscall: 'listen',
82
-
address: '::',
83
-
port: 3000
111
+
at emitErrorNT (node:net:1801:8)
112
+
at process.processTicksAndRejections (node:internal/process/task_queues:82:21) {
113
+
code: 'EADDRINUSE',
114
+
errno: -48,
115
+
syscall: 'listen',
116
+
address: '::',
117
+
port: 3000
84
118
}
85
119
86
120
Node.js v19.8.1
@@ -91,8 +125,8 @@
91
125
a. Kill the port you use and re-run the sever.
92
126
b. Go to src directory('~/pretty-git/src') and modify the `PORT` value inside index.js
93
127
94
-
```
95
-
const PORT = 3000; //<-- modify the number here.
128
+
```javascript
129
+
constPORT=3000; //<-- modify the port number here.
96
130
```
97
131
98
132
# New Features in v2.0.0
@@ -143,19 +177,19 @@ Now, you can mangage your branches on the browser.
143
177
144
178
- When you click the 'Git Log' button to the left of the 'Git Status' button, Pretty-git will show you the commit history of your project in the form of a graph.
@@ -194,9 +228,10 @@ You can easily clone both private and public repository using HTTPS of it.
194
228
- If you think an information of the access token is wrong or want to renew the token information by yourselves, you can update it in .gitconfig, which is global config file of git VCS.
195
229
196
230
- To enter and edit .gitconfig file, run the below command (The command might not work depending on your machine, especially Windows)
0 commit comments