Skip to content
No description, website, or topics provided.
Go Shell Dockerfile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cmd
data
internal
rpc/eventAPI
tests
vendor
.dockerignore
.gitignore
Dockerfile
Gopkg.lock
Gopkg.toml
README.md
arch.png
docker-compose.yml
doppler-base.env.default
entrypoint.sh
release.sh

README.md

Doppler Heatmap Go Report Card

This project provides an API for developers to track live geographical data. The process starts by 1) a client sending formatted events to an API which 2) serves the event data onto a messaging queue 3) which is read off by another API, 4) then served up live on a heatmap hosted in the browser. The backend layer is written in Go. Other components used include gRPC, Kafka, Couchbase, InfluxDB, Leaflet Maps, and Heatmap.js.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Be sure to clone and stand up the following repositories

Installing

Setting up the environment

In directory of your choice, clone Doppler-Events (Backend API/Producer), Doppler-API (Frontend API/Consumer), and Doppler-Frontend (Frontend)

git clone https://github.com/acstech/doppler-events.git
git clone https://github.com/acstech/doppler-api.git
git clone https://github.com/acstech/doppler-frontend.git

Environment Variables

Rename the doppler-base.env.default file to doppler-base.env and fill out the environment variables by following the comments.

Note: anything with an underscore in the name should be replaced with the appropriate value (ip and port need to be changed as well).

Docker Setup

In doppler-events directory:

Run docker-compose up -d

Run docker-compose ps to make sure all services are up except doppler-api and doppler-events because Couchbase has not yet been setup.

Example output:

Name                                  Command                      State     Ports                         
----------------------------------------------------------------------------------------------------------
doppler-events_doppler-api_1       ./entrypoint.sh                  Up      0.0.0.0:8000->8000/tcp

Kafka Setup

Map "Kafka" to localhost in your host file

For Mac:
* Change directories to /private/etc/
* Open the 'hosts' file in a text editor (use sudo)
* Edit the file and add 'kafka' (no quotes) after
                            127.0.0.1	localhost

Couchbase Setup

After docker is finished starting up Couchbase, visit the host:port, specified in the docker-compose.yml, file in your browser to set up Couchbase (the default host and port are localhost and 8091)

Note: Couchbase can take up to a minute after docker is running to be served to the specified host.

Create an account with a username and password of your choice.

Go to Buckets and Add Bucket (Top right)

Create a bucket (save the bucket name you give it somewhere) and configure the memory to your liking. 256 MB is recommended for Data Service Memory.

Create a user that only had read and write permissions on that same bucket using the security tab. (Located under Security->Add User->Data Roles->Data Writer and Data Roles-> Data Reader)

Create a document and name it with the following format without brackets:

[YourBucketName]:client:[YourClientName]

YourClientName will be included as a data field with each message sent to the API, remember to keep it the same.

In the JSON for the document, add the client name and an empty Events array and save. Example:

{
	"ID":"YourClientName",
    "Events":[]
}

Make sure to run docker-compose up -d again because doppler-api and doppler-events crashed due to not being able to connect to Couchbase.

Local Testing

Whenever a file changes inside of any of the three repos (doppler-api, doppler-events, doppler-frontend), the appropriate docker build command will need to be run.

In doppler-events run: docker build . -t acstintern/doppler-events:latest

In doppler-api run: docker build . -t acstintern/doppler-api:latest

In doppler-frontend run: docker build . -t acstintern/doppler-frontend:latest

And make sure that the docker-compose.yml file has either ':' or ':latest' after the doppler services, which correspond to the different repositories.

Then run docker-compose up -d and proceed to checkout the new changes.

Running the tests

At this point, if you have had no error messages come, everything is standing up. Visit the location you served the front-end to (127.0.0.1:9080 by default) in your browser and enter in your clientID. Settings can be found by clicking the hamburger icon on the top left.

Now lets try sending it some test data. Edit the doppler-events/cmd/loadtest/loadTest.go on line 27 add your clientIDs. Also edit lines 128 and 258 in doppler-events/cmd/testsend/testSend.go.

To load test the API, run go run cmd/loadtest/loadTest.go. This will not clean up your database.

To run other tests, enter go run cmd/testsend/testSend.go. To run with flags, use -s to simulate data for America only, -p to hit geographic locations multiple times, -l for infinite random latitude and longitude points. This test file has database cleanup for influx implemented after the test is finished.

Development

Click here

Built With

Contributing

Coming soon

Versioning

Version 1.0.0

Authors

License

Acknowledgments

You can’t perform that action at this time.