Permalink
Browse files

docs: fix typos

  • Loading branch information...
tbroadley committed Dec 21, 2017
1 parent ecdf945 commit 8c9f561fac7c6011a2ab2095a41ca47ccc3271d1
Showing with 5 additions and 5 deletions.
  1. +3 −3 CONTRIBUTING.md
  2. +1 −1 TUTORIAL.md
  3. +1 −1 captain-sample-apps/readme.md
View
@@ -17,7 +17,7 @@ Please note we have a code of conduct, please follow it in all your interactions
4. To keep the process simple with just a few contributors, development happens directly on the master branch
and releases will be deployed on the same branch.
## Runnig dev environment
## Running dev environment
First, you need a Captain instance running in debug mode, this can be a remote server, a VM on your local machine,
or your local machine itself. Needless to say, Docker is required (same minimum version as mentioned in README)
@@ -64,11 +64,11 @@ Change the endpoint for the backend server to your debug instance by editing thi
- `BASE_API = 'http://captain.captain.localhost/api/v1/'` if you have dnsmasq installed
- `BASE_API = 'http://127.0.0.1:3000/api/v1/'` if you don't have dnsmasq installed
You need to hardcode a logged in user to avoid having to log it with every refresh of the page. To do so, steal the auth token from the the network inspector on Chrome and hardcode it in apiManager.js.
You need to hardcode a logged in user to avoid having to log it with every refresh of the page. To do so, steal the auth token from the network inspector on Chrome and hardcode it in apiManager.js.
You can simply replace `var authToken = null` with `var authToken = 'THE_AUTH_TOKEN_STOLEN_FROM_NETWORK_INSPECTOR'`
### CLI development:
Just simply install dependecies in `app-cli` directory by running `npm install` and you are good to go!
Just simply install dependencies in `app-cli` directory by running `npm install` and you are good to go!
### Backend development:
Start the debug build for the backend service as explained above. To see any changes you make,
View
@@ -71,7 +71,7 @@ Go to the Captain in your browser, from the left menu select Apps and create a n
Follow the instructions, enter `my-first-app` when asked for app name. First time build takes about two minutes. After build is completed, visit `my-first-app.something.mydomain.com` where `something.mydomain.com` is your root domain.
CONGRATS! Your app is live!!
Note that when you run `captainduckduck deploy`, the current git commit will be sent over to your server. **IMPORATANT:** uncommited files and files in `gitignore` WILL NOT get pushed to the server.
Note that when you run `captainduckduck deploy`, the current git commit will be sent over to your server. **IMPORATANT:** uncommitted files and files in `gitignore` WILL NOT get pushed to the server.
You can visit Captain in the browser and set custom parameters for your app such as environment variables, and do much more! For more details regarding deployment, please see CLI docs. For details on `captain-definition` file, see Captain Definition File section below.
@@ -1,3 +1,3 @@
# Sample Apps
Just a bunch of sample apps for you to quickly try out functionality that Captain gives you. Most improtantly, pay attention to `captain-definition` files. Read main readme on CLI app for more details.
Just a bunch of sample apps for you to quickly try out functionality that Captain gives you. Most importantly, pay attention to `captain-definition` files. Read main readme on CLI app for more details.

0 comments on commit 8c9f561

Please sign in to comment.