eiffel-goer

module
v0.0.0-...-830f6a5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 1, 2024 License: Apache-2.0

README

Eiffel Goer

Sandbox badge

Eiffel Goer is a go implementation of the event repository API.

Description

Eiffel Goer implements the event repository API and is intended as an open source alternative to the Eiffel Event Repository.

Features

  • Simple implementation of the Eiffel ER API.
  • Event searching

Installation

Docker
docker run -e CONNECTION_STRING=yourdb -e API_PORT=8080 ghcr.io/eiffel-community/eiffel-goer:latest

If you want to select a particular version instead of the latest one, see the list of version-tagged images.

Running a development server locally for testing. Will restart on code changes.
make start
Building a local executable
make build
Running tests
make test

Contribute

Support

If you are having issues, please let us know.

There is a mailing list at: eiffel-goer-maintainers@google-groups.com or just write an Issue.

Directories

Path Synopsis
cmd
internal
database/drivers/mongodb
This package implements the database interface against MongoDB following the collection structure implemented by the Eiffel GraphQL API and Simple Event Sender.
This package implements the database interface against MongoDB following the collection structure implemented by the Eiffel GraphQL API and Simple Event Sender.
query
query is used to generate the query.go file from query.peg using pigeon as well as adding functions to the query.go package.
query is used to generate the query.go file from query.peg using pigeon as well as adding functions to the query.go package.
requests
requests is a place for request structs to be used for both database and handlers.
requests is a place for request structs to be used for both database and handlers.
pkg
This package is for generating the mocks that are used in test as well as global test helper functions.
This package is for generating the mocks that are used in test as well as global test helper functions.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL