instructions improvements

Signed-off-by: dan <[email protected]>

Author: iateadonut

.gitignore

@@ -1,4 +1,7 @@
 
+### Environmental variables for local development ###
+.env
+
 ### Code ###
 # Visual Studio Code - https://code.visualstudio.com/
 .settings/
@@ -159,4 +162,4 @@ vendor
 # Terraform plugins
 .terraform
 
-.env
+.env

README.md

@@ -19,4 +19,20 @@ Please see [database doc](db/README.md).
 ## Swagger
 Documentation is available at `/api/docs`.
 
-Also see [swagger doc](swagger/ledger.yaml).
+Also see [swagger doc](swagger/ledger.yaml).
+
+## Set Up Local Dev Instance
+
+in $GOPATH/src/github.com, git clone this package to /communitybridge/ledger.  You must be working from $GOPATH/src/github.com/communitybridge/ledger
+
+cp .env-example to .env and edit with the correct values
+
+- source .env
+- make setup_dev
+- make up
+- make build
+- make run
+
+Then go to: http://localhost:8080/api/health to test the simplest endpoint.
+
+Find more endpoints at http://localhost:8080/api/docs created by swagger/ledger.yaml

db/README.md

@@ -12,12 +12,16 @@ Apply schema
 ## Seeding
 Some seed data for testing exists in `db/seed.sql`.
 
-Ensure test database environment variables are set. Namely;
+Ensure test database environment variables are set. Namely:
 
 ```bash
 DATABASE_HOST
 DATABASE_PASSWORD
 DATABASE_USERNAME
 DATABASE_NAME
 DATABASE_URL="postgresql://$DATABASE_USERNAME:$DATABASE_PASSWORD@$DATABASE_HOST/$DATABASE_NAME?sslmode=disable" // required by dbmate
-```
+```
+
+An example .env file is in the root directory.  Copy that to .env and put in your own variables.
+
+Then run `source .env` before running dbmate or the make file, etc