lewiswatson/carshare-back repository overview

⁠What is Car Share Back⁠?

An Open Source API for tracking car shares.

Designed to enable easy tracking of the distance members travel as passengers and as drivers. Car share members can make informed day to day decisions about who should drive next based on the ratio of distance travelled as the driver vs as a passenger.

Written in [Go] and designed using {json:api}⁠ specification for building API's in JSON.

⁠How to use this image

$ docker run --link some-mongo:mongo lewiswatson/carshare-back

⁠Configuration Options

Run with --help flag to see the available command line arguments

$ docker run lewiswatson/carshare-back --help
usage: carshare-back [<flags>]

API for tracking car shares

Flags:
  --help              Show context-sensitive help (also try --help-long and
                      --help-man).
  --port=31415        Set port to bind to
  --mgoURL=localhost  URL to MongoDB server or seed server(s) for clusters
  --cors=URI          Enable HTTP Access Control (CORS) for the specified URI
  --version           Show application version.

If you'd like to be able to access the instance from the host without the container's IP, port mappings can be used:

$ docker run --link some-mongo:mongo -p 31415:31415 lewiswatson/carshare-back

Then, access it via http://localhost:31415⁠ or http://host-ip:31415⁠ in a browser.

⁠License

Copyright 2017 Lewis Watson

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0⁠

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

[Go]: https://golang.org/⁠ golang