Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 906 Bytes

README.md

File metadata and controls

36 lines (23 loc) · 906 Bytes
Raw

GoB Company API

A (so far) quick and dirty API server for accesing Get on Board from a company perspective.

See it live:

asciicast

Check out the swagger docs (and try it live) on http://gob-company-api.herokuapp.com/api-docs/index.html

Development

It's a simple Rails 6 API codebase. Contributions are very welcomed :)

Make sure you add rswag specs for new endopoints (or change the existing specs when you tweak any API endpoint).

Tests

For integration tests you need a valid Get on Board username and password. Set them as environment variables GOB_USERNAME and GOB_PASSWORD, for example via:

$ export GOB_USERNAME='[email protected]'
$ export GOB_PASSWORD='yoursupersecretpassword'

Then you can run:

$ rake spec

And tests should pass.