From 831f33861e71913e097e6ca52007ef597ab7e4dc Mon Sep 17 00:00:00 2001 From: George Shaw Date: Thu, 15 Feb 2018 13:55:20 -0600 Subject: [PATCH 1/3] added .github folder, added preview images in README, and restructured README --- .../CODE_OF_CONDUCT.md | 0 CONTRIBUTING.md => .github/CONTRIBUTING.md | 0 .../ISSUE_TEMPLATE.md | 0 LICENSE => .github/LICENSE | 0 README.md => .github/README.md | 31 ++++++++++++++++--- 5 files changed, 27 insertions(+), 4 deletions(-) rename CODE_OF_CONDUCT.md => .github/CODE_OF_CONDUCT.md (100%) rename CONTRIBUTING.md => .github/CONTRIBUTING.md (100%) rename ISSUE_TEMPLATE.md => .github/ISSUE_TEMPLATE.md (100%) rename LICENSE => .github/LICENSE (100%) rename README.md => .github/README.md (78%) diff --git a/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md similarity index 100% rename from CODE_OF_CONDUCT.md rename to .github/CODE_OF_CONDUCT.md diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md diff --git a/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md similarity index 100% rename from ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE.md diff --git a/LICENSE b/.github/LICENSE similarity index 100% rename from LICENSE rename to .github/LICENSE diff --git a/README.md b/.github/README.md similarity index 78% rename from README.md rename to .github/README.md index d65a0b6..89ed220 100644 --- a/README.md +++ b/.github/README.md @@ -3,14 +3,37 @@ A web-hosting control panel written in Go. *__Note:__ This software currently only runs on Linux systems.* +

-## Stack +##### Table of Contents +1. [Technology Stack](#technology-stack) +2. [Preview Images](#preview-images) +3. [Contribution Set-up & Deployment](#contribution-set-up-&-deployment) +4. [Installation for Use](#installation-for-use) + * [System Requirements](#system-requirements) + * [Installing openssh-server](#installing-openssh-server) + * [Creating the Host Key-pair](#creating-the-host-key-pair) + * [.ssh Folder and Files Permissions Reference](#.ssh-folder-and-files-permissions-reference) + * [Getting the Repository and Running](#getting-the-repository-and-running) + +## Technology Stack Backend: __[Go (1.8+)](https://golang.org/)__ Database: __[Bolt](https://github.com/boltdb/bolt)__ CSS Toolkit(s): __[Bootstrap 4](http://getbootstrap.com/) & [Font Awesome](http://fontawesome.io/)__ JS Toolkit(s): __[jQuery](https://jquery.com/)__ +## Preview Images + +gPanel Structure +![Image of gPanel Structure](https://nextwavesolutions.io/images/gPanelStructure.png) + +gPanel Server +![Image of gPanel Server](https://user-images.githubusercontent.com/30050545/36277136-9d0cdffc-1255-11e8-8a33-b503087a32f8.png) + +gPanel Account +![Image of gPanel Account](https://user-images.githubusercontent.com/30050545/36277135-9cf4feaa-1255-11e8-8957-9f02a9cfb7e4.png) + ## Contribution Set-up & Deployment To get the repo... @@ -44,9 +67,9 @@ go build gpanel.go sudo ./gpanel ``` -## Installation +## Installation for Use -#### Requirements +#### System Requirements - Linux - adduser command (already installed on most debian-based Linux systems) @@ -123,7 +146,7 @@ drwx------ 7 root root 4096 Jan 17 14:42 .. ``` -#### Installing and Running gPanel +#### Getting the Repository and Running 1. go get github.com/Ennovar/gPanel 2. cd ~/go/src/github.com/Ennovar/gPanel From 0e797b95e034695e72614e01442e6e5a9050f840 Mon Sep 17 00:00:00 2001 From: George Shaw Date: Thu, 15 Feb 2018 13:56:16 -0600 Subject: [PATCH 2/3] changed table of contents heading in readme --- .github/README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/README.md b/.github/README.md index 89ed220..28ea9b0 100644 --- a/.github/README.md +++ b/.github/README.md @@ -3,9 +3,8 @@ A web-hosting control panel written in Go. *__Note:__ This software currently only runs on Linux systems.* -

-##### Table of Contents +## Table of Contents 1. [Technology Stack](#technology-stack) 2. [Preview Images](#preview-images) 3. [Contribution Set-up & Deployment](#contribution-set-up-&-deployment) From e0cdff5a35c3dc0ed983b3b1ea5983d2a4a6a24a Mon Sep 17 00:00:00 2001 From: George Shaw Date: Thu, 15 Feb 2018 13:57:51 -0600 Subject: [PATCH 3/3] fix readme anchors --- .github/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/README.md b/.github/README.md index 28ea9b0..5921617 100644 --- a/.github/README.md +++ b/.github/README.md @@ -7,12 +7,12 @@ A web-hosting control panel written in Go. ## Table of Contents 1. [Technology Stack](#technology-stack) 2. [Preview Images](#preview-images) -3. [Contribution Set-up & Deployment](#contribution-set-up-&-deployment) +3. [Contribution Set-up & Deployment](#contribution-set-up--deployment) 4. [Installation for Use](#installation-for-use) * [System Requirements](#system-requirements) * [Installing openssh-server](#installing-openssh-server) * [Creating the Host Key-pair](#creating-the-host-key-pair) - * [.ssh Folder and Files Permissions Reference](#.ssh-folder-and-files-permissions-reference) + * [.ssh Folder and Files Permissions Reference](#ssh-folder-and-files-permissions-reference) * [Getting the Repository and Running](#getting-the-repository-and-running) ## Technology Stack