Skip to content

Commit cfe83f5

Browse files
authored
reorder links and refined code view
1 parent 723d8b1 commit cfe83f5

File tree

1 file changed

+27
-23
lines changed

1 file changed

+27
-23
lines changed

README.md

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# Gitconvex
22

3+
### Web application for managing all your git repositories
4+
35
<p align="center">
46
<img src="https://user-images.githubusercontent.com/47709856/87170859-8bfff080-c2ef-11ea-9140-b9e5db1c17d8.png" width="280">
57
<p align="center">
68
<a href="https://www.producthunt.com/posts/gitconvex-2?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-gitconvex-2" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=241240&theme=dark" alt="gitconvex - A web based UI client for managing git repositories | Product Hunt Embed" style="width: 250px; height: 54px;" width="250px" height="54px" /></a>
79
</p>
810
</p>
911

10-
## Web application for managing your git repositories
12+
## Build Status
1113

12-
![open issues](https://img.shields.io/github/issues/neel1996/gitconvex?color=orange&style=for-the-badge)
1314
![Gitconvex UI pipeline](https://img.shields.io/github/workflow/status/neel1996/gitconvex-ui/Gitconvex%20UI%20pipeline/master?label=gitconvex%20ui%20build&logo=github&style=for-the-badge)
1415
![Gitconvex Server pipeline](https://img.shields.io/github/workflow/status/neel1996/gitconvex-server/Gitconvex%20Server%20Pipeline/main?label=gitconvex%20server%20build&logo=github&style=for-the-badge)
1516

@@ -19,28 +20,25 @@
1920
2021
[![github release](https://img.shields.io/static/v1?label=gitconvex&message=v2.0.0&color=green&style=for-the-badge&logo=github)](https://github.com/neel1996/gitconvex-package/releases)
2122
[![docker image](https://img.shields.io/static/v1?label=gitconvex&message=v2.0.0&color=blue&style=for-the-badge&logo=docker)](https://hub.docker.com/repository/docker/itassistors/gitconvex)
22-
[![License](https://img.shields.io/static/v1?label=LICENSE&message=Apache-2.0&color=yellow&style=for-the-badge)](LICENSE)
23+
2324

2425
- **Option - 1** Cloning repo from **github**
2526

2627
**To be Noted :** The `master` branch contains the latest stable build of the project. For a reliable experience, always clone the repo from the master branch.
2728

28-
```
29+
``` shell
2930

30-
$ git clone https://github.com/neel1996/gitconvex.git
31-
$ cd gitconvex
31+
git clone https://github.com/neel1996/gitconvex.git
32+
cd gitconvex
3233

3334
# for Mac & Linux
34-
35-
$ make build
35+
make build
3636

3737
# for Windows
38-
39-
$ ./make.bat build
38+
./make.bat build
4039

4140
## After build completion...
42-
43-
$ ./dist/gitconvex-server
41+
./dist/gitconvex-server
4442

4543
2020/11/14 22:57:47 INFO: Starting Gitconvex server modules
4644
2020/11/14 22:57:47 INFO: Using available env config file
@@ -50,37 +48,38 @@ $ ./dist/gitconvex-server
5048

5149
- **Option - 2** If you are into **docker**, then there is also a docker image available for gitconvex
5250

53-
`docker pull itassistors/gitconvex`
51+
``` shell
52+
docker pull itassistors/gitconvex
53+
```
5454

5555
**Note:** Make sure you mount the host volume to the container to access the git repos from the host system. If you have git repos stored within your containers, then this is not required
5656

5757
- **Option - 3** Downloading the zip file from the tagged github [**release**](https://github.com/neel1996/gitconvex/releases)
5858

59-
```
59+
``` shell
6060
## Extract the downloaded zip file and execute the commands
61-
62-
$ cd gitconvex
61+
cd gitconvex
6362

6463
# for Mac & Linux
65-
$ make build
64+
make build
6665

6766
# for Windows
68-
$ ./make.bat build
67+
./make.bat build
6968

7069
```
7170

7271
# Platforms
7372

7473
|supported platforms|
75-
|--|
74+
|---|
7675
|Linux :penguin: |
7776
|Mac OS :apple: |
7877
|Windows :black_square_button: |
7978

8079
## Requirements
8180

8281
| Software | Purpose |
83-
| -- | -- |
82+
| --- | --- |
8483
| <b>[Git](https://git-scm.com/)</b> | <b>Required for handling some intense git operations with the target repo</b> |
8584
| <b>[Go](https://golang.org/)</b> | <b>For building the backend from the source</b> |
8685
| <b>[Node JS](https://nodejs.org/en/)</b> | <b>For building the react UI bundle from scratch</b> |
@@ -91,15 +90,15 @@ If you are a windows user, then make sure that `git` is accessible from the comm
9190

9291
- Open command prompt or powershell and enter `git --version` and press enter. If it displays the following output, then it is fine
9392

94-
```
93+
``` cmd
9594
C:\> git --version
9695
9796
git version 2.28.0.windows.1
9897
```
9998

10099
If this output is not displayed and if the command throws the following error, then it shows that `git` is not added to the 'path' environment variable and it will not be accessible directly from the command line,
101100

102-
```
101+
``` cmd
103102
C:\> git --version
104103
105104
'git' is not recognized as an internal or external command,
@@ -140,9 +139,14 @@ For reporting issues or for requesting any feature use the following medium,
140139

141140
[**Discord Channel** ](https://discord.gg/PSd2Cq9)
142141

142+
[**Website**](https://gitconvex.com/)
143+
143144
[**Github Issue Reporting**](https://github.com/neel1996/gitconvex/issues)
144145

146+
![open issues](https://img.shields.io/github/issues/neel1996/gitconvex?color=orange&style=for-the-badge)
147+
145148
# License
146149

147-
See [LICENSE ](LICENSE) info for more
150+
[![License](https://img.shields.io/static/v1?label=LICENSE&message=Apache-2.0&color=yellow&style=for-the-badge)](LICENSE)
151+
148152

0 commit comments

Comments
 (0)