Skip to content

Commit

Permalink
contributing.md first commit
Browse files Browse the repository at this point in the history
Added the contributing file to explain the project dependencies and how to run a local version.
A small update in the /gae/run.sh was made to allow the file to be executed from any other folder.

Fixes matryer#21
  • Loading branch information
bgadrian committed Jul 16, 2018
1 parent 65d8b26 commit 14d4cdf
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Contributing to Gopherize.me

[gopherize.me](https://gopherize.me) is an open source project. Your help is very welcome!

## Filing issues

Sensitive security-related issues should be reported to [Mat Ryer directly](https://twitter.com/matryer).

For any other problem fill up a new issue describing your feature request or problem.

## Contributing code
To use Github you will need to install [Git](https://git-scm.com/downloads) and (optional) [Github credentials setup](https://help.github.com/articles/connecting-to-github-with-ssh/)

1. File up a new issue (or use an existing open one)
2. [Fork this repository](https://help.github.com/articles/fork-a-repo/)
3. [Download your repository](https://help.github.com/articles/cloning-a-repository/) on your computer
4. Make a new branch `git checkout -b myNewBranch`
5. Update your repository and [make a pull request](https://help.github.com/articles/creating-a-pull-request/)


## Installing the project
In order to make the project work on your local computer you need the following:

* [Google Cloud SDK](https://cloud.google.com/sdk/install) with the **App Engine Go Extensions** component installed.
* [Go](https://golang.org/doc/install) the language and tools
* the local copy of your repository must be in the [GOPATH folder](https://github.com/golang/go/wiki/SettingGOPATH)
* run `go get ./...` in the project main folder, in order to install its dependencies

## Run the project
The project runs using the local [Google App Engine development server](https://cloud.google.com/appengine/docs/standard/go/tools/using-local-server). The command that runs it is already written in a [bash file](./gae/run.sh).

```bash
./gae/run.sh
```
Windows/others see the [Development server docs](https://cloud.google.com/appengine/docs/standard/go/tools/using-local-server#running_the_local_development_server).

> Note: The config for the app engine server is `/gae/app.yaml`.
After the server starts, you can visit [http://localhost:8080/](http://localhost:8080/) in your web browser to see the app in action.
1 change: 1 addition & 0 deletions gae/run.sh
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
#!/bin/bash
cd "$(dirname "$0")"
dev_appserver.py --default_gcs_bucket_name gopherizeme.appspot.com ./app.yaml

0 comments on commit 14d4cdf

Please sign in to comment.