Merge pull request #12 from george-e-shaw-iv/master

updated readme and contribution
This commit is contained in:
George Shaw 2017-10-20 14:56:56 -05:00 committed by GitHub
commit 0e7ee44170
6 changed files with 38 additions and 14 deletions

View file

@ -12,15 +12,34 @@ CSS Preprocessor: __[SASS](http://sass-lang.com/)__
CSS Toolkit: __[Bootstrap 4](http://getbootstrap.com/)__
Package Manager: __[npm](https://www.npmjs.com/)__
## Deployment
## Contribution Set-up & Deployment
```shell
# Clone the Repo
git clone https://github.com/Ennovar/gPanel.git
# Go get the repo and append it to your $GOPATH
go get https://github.com/Ennovar/gPanel.git
# Navigate to the directory
cd gPanel
# Start the web-hosting server
go run main.go
# Navigate to the directory (replace $GOPATH with your actual $GOPATH)
cd $GOPATH/github.com/Ennovar/gPanel
```
To set your repo up to contribute...
```shell
# Fork the repo and add it to the list of remotes
git remote add fork https://github.com/Ennovar/gPanel.git
# OPTIONAL: Change the names of the remotes
git remote rename origin upstream
git remote rename fork origin
```
To deploy...
```shell
# Starting gPanel
go run main.go
# OPTIONAL: Create binary to run
go build main.go
./main
```

View file

@ -1,10 +1,11 @@
package main
import (
"gPanel/private_server/routing"
"gPanel/public_server/routing"
"log"
"net/http"
"github.com/Ennovar/gPanel/private_server/routing"
"github.com/Ennovar/gPanel/public_server/routing"
)
func main() {

View file

@ -1,10 +1,11 @@
package privateLogging
import (
"gPanel/general/networking"
"log"
"os"
"strings"
"github.com/Ennovar/gPanel/general/networking"
)
const (

View file

@ -2,10 +2,11 @@ package privateRouting
import (
"bufio"
"gPanel/private_server/logging"
"net/http"
"os"
"strings"
"github.com/Ennovar/gPanel/private_server/logging"
)
type privateHost struct {

View file

@ -1,10 +1,11 @@
package publicLogging
import (
"gPanel/general/networking"
"log"
"os"
"strings"
"github.com/Ennovar/gPanel/general/networking"
)
const (

View file

@ -2,10 +2,11 @@ package publicRouting
import (
"bufio"
"gPanel/public_server/logging"
"net/http"
"os"
"strings"
"github.com/Ennovar/gPanel/public_server/logging"
)
type publicWeb struct {