{"id":25860410,"url":"https://github.com/kekland/lapisdb","last_synced_at":"2025-03-01T22:34:27.944Z","repository":{"id":34302153,"uuid":"169527949","full_name":"kekland/lapisdb","owner":"kekland","description":"A modern, easy-to-use and feature-rich TypeScript embedded database.","archived":false,"fork":false,"pushed_at":"2023-01-12T01:43:03.000Z","size":2741,"stargazers_count":20,"open_issues_count":25,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-15T07:49:14.682Z","etag":null,"topics":["database","db","embeddable","embedded-database","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kekland.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-02-07T06:17:56.000Z","updated_at":"2023-09-24T17:25:30.000Z","dependencies_parsed_at":"2023-01-15T06:07:27.569Z","dependency_job_id":null,"html_url":"https://github.com/kekland/lapisdb","commit_stats":null,"previous_names":["kekland/sirano"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kekland%2Flapisdb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kekland%2Flapisdb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kekland%2Flapisdb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kekland%2Flapisdb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kekland","download_url":"https://codeload.github.com/kekland/lapisdb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241435145,"owners_count":19962400,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["database","db","embeddable","embedded-database","typescript"],"created_at":"2025-03-01T22:34:17.314Z","updated_at":"2025-03-01T22:34:27.914Z","avatar_url":"https://github.com/kekland.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 💥 LapisDB\n\n[![star this repo](http://githubbadges.com/star.svg?user=kekland\u0026repo=lapisdb\u0026style=flat)](https://github.com/kekland/lapisdb)\n[![fork this repo](http://githubbadges.com/fork.svg?user=kekland\u0026repo=lapisdb\u0026style=flat)](https://github.com/kekland/lapisdb/fork)\n[![License](https://img.shields.io/github/license/kekland/lapisdb.svg)](https://github.com/kekland/lapisdb)\n[![Version](https://img.shields.io/npm/v/lapisdb.svg)](https://www.npmjs.com/package/lapisdb)\n[![Downloads](https://img.shields.io/npm/dt/lapisdb.svg)](https://www.npmjs.com/package/lapisdb)\n[![Status](https://travis-ci.org/kekland/lapisdb.svg?branch=master)](https://travis-ci.org/kekland/lapisdb)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/7203331dd64d47a290ac3e9ce3ef6d95)](https://www.codacy.com/app/kekland/lapisdb?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=kekland/lapisdb\u0026amp;utm_campaign=Badge_Grade)\n\nA **TypeScript** embedded database that is really easy and nice to use. \n\n## Attention\n\nI am still working on this project, and many things **might change in future**.\n\n## Example\n\nYou can check out a full REST API [here](https://github.com/kekland/lapisdb-example).\n\n```ts\nconst adapter = new LevelDbAdapter(News, { name: 'news', directory: './database' })\nconst db = new Datastore('news', adapter)\nDatastoreManager.register(db)\n\nexport class News extends Model\u003cNews\u003e {\n  body: string;\n  author: string;\n\n  constructor(body: string, author: string) {\n    super(News)\n\n    this.body = body\n    this.author = author\n  }\n}\n\n// Getting items\nconst items: News[] = await db.getItems()\n\n// Filtering results\nconst items: News[] = await db.getItems((n) =\u003e n.author === 'kekland')\n\n// Getting single item\nconst item: News = await db.get('identifier')\n\n// Getting single item through its parameters\nconst item: News = await db.get({author: 'kekland'})\n\n// Adding an item\nconst newItem: News = await new News('interesting body', 'kekland').save()\n\n// Editing an item\nnewItem.body = 'a more interesting body'\nawait newItem.save()\n\n// Getting a reference to an item\nconst reference: Reference\u003cNews\u003e = newItem.getReference()\n\n// Getting an item through its reference\nconsole.log((await reference.get(News)) === newItem) // true\n\n// Deleting an item\nawait newItem.delete()\n\n```\n\n## Why?\n\nDuring my experience writing servers, I often cannot find a database that is both **fast** and **easy** to use.\n\n**LapisDB** tries to solve this problem. It is fully typed and uses **TypeScript** to make the development process a blast.\n\n## Try it out!\n\n```bash\ncd my-awesome-project\nnpm install --save lapisdb\n```\n\n[**Download via NPM**](https://npmjs.com/package/lapisdb)\n\n##  How do I use it?\n\n### 📋 Tutorial\n\nCheck out the **GitHub Wiki** page [here](https://github.com/kekland/lapisdb/wiki).\n\n### 📕 Documentation\n\nYou can find the full **TypeDoc documentation** [here](https://kekland.github.io/lapisdb) (not updated as of v0.3.0).\n\n## Plugins, additional features\n\n- [LapisDB observatory](https://github.com/kekland/lapisdb_observatory)\n\n- [LevelDB adapter](https://github.com/kekland/lapisdb-level-adapter)\n\n## Contact me\n\n**E-Mail**: `kk.erzhan@gmail.com`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkekland%2Flapisdb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkekland%2Flapisdb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkekland%2Flapisdb/lists"}