0.1.0 • Published 5 years ago

lapisdb_observatory v0.1.0

Weekly downloads
3
License
MIT
Repository
github
Last release
5 years ago

💥 LapisDB Observatory

star this repo fork this repo License

A web observatory for LapisDB.

❗ Attention

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

💾 Installation

Download via NPM

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.

Then, you create LapisObservatory object:

const myDatastore = new Datastore(...)

const observatory = new LapisObservatory([myDatastore])

And then, you just start the observatory

observatory.listen(9009)

Yes, it is that simple!

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

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