Skip to content

Commit

Permalink
Minor improvements in readme steps
Browse files Browse the repository at this point in the history
  • Loading branch information
xferra committed Feb 16, 2017
1 parent c5d9767 commit 8ea21d2
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,25 @@ If you have any issues or questions - feel free to [create an issue](https://git
- [Google Cloud SDK](https://cloud.google.com/sdk/)

## Before you start
- Clone repository
- Set path to git 'GitPath' in [tasks.json](https://github.com/xferra/netcore-jshint/blob/master/.vscode/launch.json#L30) and/or in Env variables
- [Generate Personal Access Token](https://github.com/settings/tokens) in GitHub (enable repo scope). Set 'GitHubToken' in [tasks.json](https://github.com/xferra/netcore-jshint/blob/master/.vscode/launch.json#L32) and [dockerfile](https://github.com/xferra/netcore-jshint/blob/master/Dockerfile#L29)
- Feel free to update 'GitHubName' and 'GitHubUrl' (optional)
- Windows Users: you will need to [execute cmd instead of bash](https://github.com/xferra/netcore-jshint/blob/master/src/Utils/Helper.cs#L61) - TODO

## Getting started (locally)
1. Clone repository
2. `cd` to the `project root/src`
3. Restore dependencies `dotnet restore`
4. Build project `dotnet build`
5. Run `dotnet run` - app started ([http://localhost:5000](http://localhost:5000))
1. `cd` to the `project root/src`
2. Restore dependencies `dotnet restore`
3. Build project `dotnet build`
4. Run `dotnet run` - app started ([http://localhost:5000](http://localhost:5000))

## Getting started (docker)
1. `cd` to the `project root`
2. Build image `docker build -t mycontainer:v1 .`
3. Run `docker run -i -p 8181:8181 -t mycontainer:v1` - app started ([http://localhost:8181](http://localhost:8181))

## Getting started (cloud)
0. You need to [create project](https://cloud.google.com/resource-manager/docs/creating-managing-projects), Enable Billing (free trial available), [Set Default Credentials](https://developers.google.com/identity/protocols/application-default-credentials)
0. [Create project](https://cloud.google.com/resource-manager/docs/creating-managing-projects), Enable Billing (free trial available), [Set Default Credentials](https://developers.google.com/identity/protocols/application-default-credentials)
1. Let's say project id 'myproject', docker image name 'gcr.io/myproject/mycontainer:v1', cluster name 'mycluster'. Google App credentials path is correct `GOOGLE_APPLICATION_CREDENTIALS=PATH_TO_FILE`.
2. Install kubernetes `gcloud components install kubectl`
3. Build image for cloud `docker build -t gcr.io/myproject/mycontainer:v1 .`
Expand All @@ -45,6 +45,7 @@ If you have any issues or questions - feel free to [create an issue](https://git
11. Get external IP address `kubectl get services` - app started (use your external IP)

## GitHub Integration
0. Create GitHub account
1. [Create new GitHub integration](https://github.com/settings/integrations)
2. Use any name, url: 'http://external_ip_from_cloud:8181/Home/Webhook', enable 'Commit statuses' (Permissions & events)
3. Create a repo for tests
Expand Down

0 comments on commit 8ea21d2

Please sign in to comment.