https://github.com/kekland/lapisdb_observatory

A web data observer for LapisDB
https://github.com/kekland/lapisdb_observatory

embedded-database lapisdb leveldb stenciljs typescript

Last synced: 4 months ago
JSON representation

A web data observer for LapisDB

• Host: GitHub
• URL: https://github.com/kekland/lapisdb_observatory
• Owner: kekland
• License: mit
• Created: 2019-06-21T08:20:50.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T19:47:13.000Z (almost 3 years ago)
• Last Synced: 2025-06-05T18:46:34.057Z (4 months ago)
• Topics: embedded-database, lapisdb, leveldb, stenciljs, typescript
• Language: TypeScript
• Size: 526 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 💥 LapisDB Observatory

[![star this repo](http://githubbadges.com/star.svg?user=kekland&repo=lapisdb_observatory&style=flat)](https://github.com/kekland/lapisdb_observatory)

[![fork this repo](http://githubbadges.com/fork.svg?user=kekland&repo=lapisdb_observatory&style=flat)](https://github.com/kekland/lapisdb_observatory/fork)

[![License](https://img.shields.io/github/license/kekland/lapisdb_observatory.svg)](https://github.com/kekland/lapisdb_observatory)

A web observatory for [**LapisDB**](https://github.com/kekland/lapisdb).

## ❗ Attention

I am still working on this project, and many things **might change in future**.

## Screenshots

![screenshot 1](./images/main.jpg)

![screenshot 2](./images/humans.jpg)

## 💾 Installation

[**Download via NPM**](https://https://www.npmjs.com/package/lapisdb_observatory)

```bash

cd my-awesome-project

npm install --save lapisdb_observatory

```

## 🔨 How do I use it?

First of all, you need to create LapisDB datastores - if you are wondering how to do it, check out this [link](https://github.com/kekland/lapisdb).

Then, you create LapisObservatory object:

```ts

const myDatastore = new Datastore(...)

const observatory = new LapisObservatory([myDatastore])

```

And then, you just start the observatory

```ts

observatory.listen(9009)

```

Yes, it is that simple!

When you build and start your server, it will print information about its routes in terminal.

```bash

Starting LapisObservatory on port 9009

[Datastore human] listening on route /human and /human/:id

[Datastore dog] listening on route /dog and /dog/:id

LapisObservatory started on port 9009

```

Then, you can open your web browser and navigate to `localhost:9009/human` :)

## 📧 Contact me

**E-Mail**: `kk.erzhan@gmail.com`