customer-os-analytics-api

README

customerOS analytics API

GraphQL APIs to browse customer analytics data

_{Built with ❤︎ by the Openline community!}

🤝 Dependencies

1. gorm - ORM library

   go get -u gorm.io/gorm
   

2. gqlgen - Type-safe GraphQL for Go

   Generate models from schema:

   go generate ./...
   

3. gin - Web framework for Go

   go get -u github.com/gin-gonic/gin
   

🚀 Quick start

1. Add any missing module requirements necessary to build the current module’s packages and dependencies, and remove requirements on modules that don’t provide any relevant packages.

   go mod tidy
   

2. Generate graphql models

   go generate ./...
   

3. Set environment variables for DB connection:

   1. DB_HOST
   2. DB_PORT
   3. DB_NAME
   4. DB_USER
   5. DB_PWD

4. Start the graphql server

   go run server.go
   

💪 Contributions

We ❤️ contributions! If you'd like to help out, check out our contributors guide.