{"id":14529226,"url":"https://github.com/aerotoad/neboa","last_synced_at":"2025-05-07T04:04:27.660Z","repository":{"id":184196937,"uuid":"671448528","full_name":"aerotoad/neboa","owner":"aerotoad","description":"Type-safe NoSQL with Node \u0026 SQLite. 🌫️💽","archived":false,"fork":false,"pushed_at":"2023-09-22T00:43:54.000Z","size":336,"stargazers_count":174,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-07T04:04:19.705Z","etag":null,"topics":["database","document","nodejs","nosql","sqlite3","typescript"],"latest_commit_sha":null,"homepage":"https://aerotoad.github.io/neboa/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aerotoad.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-27T10:42:00.000Z","updated_at":"2025-04-06T00:56:40.000Z","dependencies_parsed_at":"2024-10-22T14:58:35.213Z","dependency_job_id":null,"html_url":"https://github.com/aerotoad/neboa","commit_stats":null,"previous_names":["aerotoad/nebra"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aerotoad%2Fneboa","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aerotoad%2Fneboa/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aerotoad%2Fneboa/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aerotoad%2Fneboa/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aerotoad","download_url":"https://codeload.github.com/aerotoad/neboa/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252810270,"owners_count":21807759,"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","document","nodejs","nosql","sqlite3","typescript"],"created_at":"2024-09-05T00:00:57.735Z","updated_at":"2025-05-07T04:04:27.609Z","avatar_url":"https://github.com/aerotoad.png","language":"TypeScript","readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/aerotoad/neboa/blob/main/docs/public/social-image.png?raw=true\" style=\"max-height:500px;\"\u003e\n  \u003cp\u003e\u003c/p\u003e\n  \n  \u003c!--\u003ch1\u003eNeboa :fog:\u003c/h1\u003e\n  \u003ch4\u003e\u003ci\u003eSeamless Data Management with Neboa: Type-Safe NoSQL for Node \u0026 SQLite.\u003c/i\u003e\u003c/h4\u003e--\u003e\n  \u003ca href=\"https://www.npmjs.com/neboa\" rel=\"nofollow\"\u003e\n    \u003cimg alt=\"Neboa on npm\" src=\"https://img.shields.io/npm/v/neboa.svg?logo=npm\u0026amp;logoColor=fff\u0026amp;label=NPM+package\u0026amp;color=f59e0b\" style=\"max-width: 100%;\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/aerotoad/neboa/actions/workflows/ci.yml\"\u003e\n    \u003cimg src=\"https://github.com/aerotoad/neboa/actions/workflows/ci.yml/badge.svg\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/aerotoad/neboa/blob/main/LICENSE\"\u003e\n    \u003cimg alt=\"GitHub\" src=\"https://img.shields.io/github/license/aerotoad/neboa?logo=opensourceinitiative\u0026logoColor=ffffff\"\u003e\n  \u003c/a\u003e\n  \u003cimg src=\"https://img.shields.io/badge/Project%20Status-Alpha-yellow?logo=git\u0026amp;logoColor=white\" style=\"max-width: 100%;\"\u003e\n  \u003ca href=\"https://github.com/aerotoad/neboa/blob/main/CONTRIBUTING.md\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg\" style=\"max-width: 100%;\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/aerotoad/neboa/stargazers\"\u003e\n    \u003cimg alt=\"GitHub Repo stars\" src=\"https://img.shields.io/github/stars/aerotoad/neboa?logo=github\"\u003e\n  \u003c/a\u003e\n\n\u0026nbsp; \n\n  \u003cp align=\"center\" dir=\"auto\"\u003e\n    \u003cb\u003e:sparkles: Type-Safe\u003c/b\u003e |\n    \u003cb\u003e:minidisc: SQLite\u003c/b\u003e |\n    \u003cb\u003e:battery: Batteries Included\u003c/b\u003e |\n    \u003cb\u003e:lotus_position: Flexible\u003c/b\u003e\n  \u003c/p\u003e\n\n  \u003chr /\u003e\n\u003c/div\u003e\n\n## Description\n\nNeboa (pronounced /ˈnɛβo̯a̝/, [from Galician](https://en.wiktionary.org/wiki/n%C3%A9boa#Galician): «fog») is a simple, yet powerful, type-safe NoSQL database library for Node.js. It offers seamless data management with compile-time type-checking for enhanced reliability. Leveraging SQLite, Neboa ensures efficient and lightweight performance, making it perfect for Electron and other platforms. With its unique approach, Neboa empowers you to use a relational database as a NoSQL, providing the flexibility to harness the best of both worlds. Effortlessly manage your data and embrace a misty-smooth database experience.\n\nUnder the hood, Neboa makes use of [better-sqlite3](https://github.com/WiseLibs/better-sqlite3), a high-performance SQLite wrapper. This powerful tool allows Neboa to deliver optimal performance and ensure smooth interactions with the database. Whether you're building a desktop application with Electron or a web-based project, Neboa's reliable and efficient architecture has got you covered.\n\n## Getting Started\n\nIt's recommended to read the [documentation](https://aerotoad.github.io/neboa/) to learn more about Neboa and how to use it.\n\nIf you want to jump right in, you can install Neboa in your project and start using folliwing the steps below:\n\n### Install Neboa\n```sh\nnpm install neboa\n```\n\n### Create a new Neboa instance and initialize the database\n```typescript\nimport { neboa } from 'neboa';\nconst db = neboa('path/to/database.db');\n```\n\n### Create a new collection\n```typescript\nconst Users = db.collection('users');\n```\n\n### Insert a new document to the collection\n```typescript\nconst user = Users.insert({\n  name: 'Darth Vader',\n  email: 'vader@imperial.net'\n});\n```\n\nAnd just like that, you have a new collection populated with a document. You can now query the collection to retrieve the document.\n\nIf you want to learn more about Neboa, you can read the [documentation](https://aerotoad.github.io/neboa/) to get started.\n\nHappy hacking! :tada:\n\n## Documentation\n\nYou can see the documentation on the [website](https://aerotoad.github.io/neboa/). \n\u003cbr/\u003e\nBelow you can find table of contents with useful links to the documentation.\n\n#### Introduction\n- [What is Neboa](https://aerotoad.github.io/neboa/guide/what-is-neboa)\n- [Gettting Started](https://aerotoad.github.io/neboa/guide/getting-started)\n\n#### Basic Usage\n- [Connecting to a Database](https://aerotoad.github.io/neboa/guide/basic/connecting-a-database)\n- [Working with collections](https://aerotoad.github.io/neboa/guide/basic/collections)\n\n#### Queries\n- [Creating Queries](https://aerotoad.github.io/neboa/guide/queries/creating-queries)\n- [Query constraints](https://aerotoad.github.io/neboa/guide/queries/query-constraints)\n- [Relational Data](https://aerotoad.github.io/neboa/guide/queries/relational-data)\n\n#### Advanced\n- [Subscriptions](https://aerotoad.github.io/neboa/guide/advanced/subscriptions)\n\n## Contributing\n\nThanks for your interest in contributing! Please, read on the guidelines for [contributing](CONTRIBUTING.md) and then check the [issues](https://github.com/aerotoad/neboa/issues) to see if there's anything you can help with.\n\nPlease note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.\n\n## License\n\nSee the [LICENSE](LICENSE) file for license rights and limitations (Affero General Public License v3.0).\n\n","funding_links":[],"categories":["**1. Libraries**","TypeScript","Packages"],"sub_categories":["Database"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faerotoad%2Fneboa","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faerotoad%2Fneboa","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faerotoad%2Fneboa/lists"}