https://github.com/k4itrun/simple.db
A simple and efficient JSON database for Node.js with TypeScript support and automatic persistence !
https://github.com/k4itrun/simple.db
db json nosql
Last synced: about 1 month ago
JSON representation
A simple and efficient JSON database for Node.js with TypeScript support and automatic persistence !
- Host: GitHub
- URL: https://github.com/k4itrun/simple.db
- Owner: k4itrun
- Created: 2025-03-18T19:16:37.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-04-13T20:34:49.000Z (about 1 month ago)
- Last Synced: 2025-04-13T21:30:17.389Z (about 1 month ago)
- Topics: db, json, nosql
- Language: TypeScript
- Homepage:
- Size: 47.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# simple-db
A simple and efficient JSON database for Node.js with TypeScript support and automatic persistence !
## Installation
```
npm install @k4i/simple.db
pnpm install @k4i/simple.db
yarn add install @k4i/simple.db
```
## Usage
To use this simple DB using JSON, follow these instructions:
### Import simple-db:
```javascript
const DB = require('@k4i/simple.db'); // CJS
import DB from "@k4i/simple.db"; // ES6
```
### Create the db:
```javascript
const db = new DB(); // by default will create db.json
const db = new DB('./mydb.json'); // create a new DB with the specified name
```
## Example with sample data
- [example-cjs](./example.cjs)
- [example-mjs](./example.mjs)
## Contributing
We welcome contributions! If you’d like to improve this project, feel free to submit issues, open pull requests, or share your suggestions.
## License
This project is distributed under the MIT License. Check the LICENSE file for more details.
## Contact
For any inquiries or support, you can reach out via [[email protected]](mailto:[email protected]) or join our [Discord Server](https://discord.gg/CMNd45AXvD).