From 8ea21d214c385d20e0b00d55269f6d18bfa6cd7f Mon Sep 17 00:00:00 2001 From: xferra Date: Thu, 16 Feb 2017 11:26:11 +0300 Subject: [PATCH] Minor improvements in readme steps --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c6ca9b1..1f03f01 100644 --- a/README.md +++ b/README.md @@ -13,17 +13,17 @@ 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` @@ -31,7 +31,7 @@ If you have any issues or questions - feel free to [create an issue](https://git 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 .` @@ -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