Skip to content

Latest commit

 

History

History
50 lines (43 loc) · 2.27 KB

README.md

File metadata and controls

50 lines (43 loc) · 2.27 KB
Raw

Just Pikd WMS

Development Setup:

  1. Currently just boot the vagrant image from the just-pikd repo
  2. Clone this repo into ~/Documents/just-pikd-wms
  3. vagrant ssh to the dev box
  4. Need to fix permissions via chef, but do this after provisioning: sudo chown -R vagrant:vagrant /opt/go
  5. Add to ~/.bashrc (and source it) export GOPATH='/opt/go' export PATH=$GOPATH:$PATH
  6. I use gin for live code reloading: go get github.com/codegangsta/gin
  7. Dependency management: go get github.com/tools/godep
  8. Set cwd to the WMS directory: cd /opt/go/src/just-pikd-wms
  9. Install deps: godep restore
  10. Run gin to start the app, and it should reload when you change code (it can be somewhat slow).

I'm also using GoSublime. I had to set GOPATH and install some packages on my mac to get formatting/syntax highlighting to work. Standardizing that is another TODO item. In GoSublime package settings, I did this:

{
        "shell": ["/usr/bin/bash"],
        "env": {"GOPATH": "/Users/Scott/go/",
        "GOROOT": "/opt/local/go"},
}

Running Tests:

Use ./test to run all tests, or the go test command to get finer grained control over running individual tests

Test Data Generation:

In the test_data folder, generate_sql.xlsx was used to generate some static records. generate_test_data.sql contains statements based off of that to generate additional data, as well as examples of how to dump it to json files

Navigating the Repository:

Code is broken up into subfolders and subpackages for organization:

  1. config/ contains configuration loading
  2. controllers/ contains handler functions for each route which parse input, invoke daos and write a response or error
  3. daos/ contains methods for data access
  4. Godeps/ doesn't contain go code and is used to vendor dependencies with godep
  5. integration/ contains integration tests
  6. models/ contains data models, structs which map to business objects
  7. public/ contains directly accessible static files, served by the webserver under the /public/ path
  8. server/ contains the code to set up the webserver including middleware handler, DB connection pool, and the list of routes
  9. test_data/ contains static files of test data and example scripts to generate test data