jshbrmn/braid
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme addition

Browse Source
This commit is contained in:
Josh Burman 2019-03-14 17:37:57 -04:00
parent b487187d22
commit e6274901ed
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -9,6 +9,8 @@
* braid uses [typescript](https://www.npmjs.com/package/typescript) for our primary code development because of it's opinionated type management among other things. Get a good understanding of what typescript is, it's benifits, drawbacks, and dev flow * braid uses [typescript](https://www.npmjs.com/package/typescript) for our primary code development because of it's opinionated type management among other things. Get a good understanding of what typescript is, it's benifits, drawbacks, and dev flow
## Setting up ## Setting up
* install (npm)[https://www.npmjs.com/get-npm]
* install typescript globally (`npm i -g typescript`). This is important because it is needed to transcompile, so you can run your changes, locally (using command `tsc`)
* download the braid repo into a folder in the same directory as the primary yardstick folder * download the braid repo into a folder in the same directory as the primary yardstick folder
* `vagrant up` in the primary yardstick folder * `vagrant up` in the primary yardstick folder
* run the command `compose stop braid && compose rm braid && tsc && compose build braid && compose up -d` * run the command `compose stop braid && compose rm braid && tsc && compose build braid && compose up -d`
@ -17,7 +19,7 @@
* `tsc` transpiles the typescript in braid into javascript * `tsc` transpiles the typescript in braid into javascript
* `compose build braid` builds the braid container based on the latest transpiled javascript files * `compose build braid` builds the braid container based on the latest transpiled javascript files
* `comopose up -d` builds the braid container based on the files in the braid folder, overriding the defaul braid build container * `comopose up -d` builds the braid container based on the files in the braid folder, overriding the defaul braid build container
## Building to Docker Hub ## Building to Docker Hub
* run `./build` * run `./build`
* when complete you'll see something like this `Your new docker tag: yardstick/micro-services:braid-tagid` * when complete you'll see something like this `Your new docker tag: yardstick/micro-services:braid-tagid`