Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dacr/spy

spy web service with API
https://github.com/dacr/spy

api openapi pekko pekko-http

Last synced: about 1 month ago
JSON representation

spy web service with API

Host: GitHub
URL: https://github.com/dacr/spy
Owner: dacr
License: other
Created: 2021-02-28T19:56:03.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2024-10-12T10:37:34.000Z (3 months ago)
Last Synced: 2024-10-19T00:58:17.579Z (3 months ago)
Topics: api, openapi, pekko, pekko-http
Language: Scala
Homepage:
Size: 2.44 MB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # ![](images/logo-base-32.png) spy service ![tests][tests-workflow] [![License][licenseImg]][licenseLink] [![][SpyMvnImg]][SpyMvnLnk]

It has been deployed on [https://mapland.fr/spy][deployed]

## Quick local start

Thanks to [scala-cli][scl],

this application is quite easy to start, just execute :

```

scala-cli --dep fr.janalyse::spy:1.0.7 -e 'spy.Main.main(args)'

```

## Configuration

| Environment variable | Description                            | default value           |

|----------------------|----------------------------------------|-------------------------|

| SPY_LISTEN_IP        | Listening network interface            | "0.0.0.0"               |

| SPY_LISTEN_PORT      | Listening port                         | 8080                    |

| SPY_PREFIX           | Add a prefix to all defined routes     | ""                      |

| SPY_URL              | How this service is known from outside | "http://127.0.0.1:8080" |

| SPY_STORE_PATH       | Where data is stored                   | "/tmp/spy-data"         |

[cs]: https://get-coursier.io/

[scl]: https://scala-cli.virtuslab.org/

[deployed]:   https://mapland.fr/spy

[akka-http]:  https://doc.akka.io/docs/akka-http/current/index.html

[Spy]:       https://github.com/dacr/spy

[SpyMvnImg]: https://img.shields.io/maven-central/v/fr.janalyse/spy_2.13.svg

[SpyMvnLnk]: https://search.maven.org/#search%7Cga%7C1%7Cfr.janalyse.spy

[tests-workflow]: https://github.com/dacr/spy/actions/workflows/scala.yml/badge.svg

[licenseImg]: https://img.shields.io/github/license/dacr/spy.svg

[licenseLink]: LICENSE