https://github.com/josh-development/core

Javascript Object Storage Helper
https://github.com/josh-development/core

hacktoberfest node persistent-storage typescript

Last synced: about 1 year ago
JSON representation

Javascript Object Storage Helper

• Host: GitHub
• URL: https://github.com/josh-development/core
• Owner: josh-development
• License: apache-2.0
• Created: 2019-02-19T19:35:41.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T16:56:08.000Z (over 1 year ago)
• Last Synced: 2024-10-29T23:19:40.436Z (over 1 year ago)
• Topics: hacktoberfest, node, persistent-storage, typescript
• Language: TypeScript
• Homepage:
• Size: 16 MB
• Stars: 74
• Watchers: 4
• Forks: 12
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          


![Josh Logo](https://evie.codes/josh-light.png)

# @joshdb/core

**JavaScript Object Storage Helper**

[![GitHub](https://img.shields.io/github/license/josh-development/core)](https://github.com/josh-development/core/blob/main/LICENSE.md)

[![npm](https://img.shields.io/npm/v/@joshdb/core?color=crimson&logo=npm&style=flat-square)](https://www.npmjs.com/package/@joshdb/core)

[![codecov](https://codecov.io/gh/josh-development/core/branch/main/graph/badge.svg?token=JnJcjxqT3k)](https://codecov.io/gh/josh-development/core)

[![Support Server](https://discord.com/api/guilds/298508738623438848/embed.png?style=banner2)](https://discord.gg/N7ZKH3P)



---

## Description

A simple, effective, and efficient database wrapper.

## Features

- Written in TypeScript

- Offers CommonJS, ESM and UMD bundles

- Fully tested

## Installation

You can use the following command to install this package, or replace `npm install` with your package manager of choice.

```sh

npm install @joshdb/core@next

```

## Documentation

Unfortunately, the website to host the documentation is not yet ready, but you can check on it's progress [here](https://github.com/josh-development/website)

## FAQ

### What is Josh?

Josh is quite simply the easiest storage system you'll ever encounter. Josh makes it simple to store any JSON-based data effectively into any popular database back-end using providers.

### Why use Josh?

Josh makes it extremely easy and simple to get a project up and running as quickly as possible with very little effort when it comes to the database interaction layer. It does this by removed the complexity of setting up and ORM or learning a database language, while still giving you all the power.

### When NOT to use Josh?

If you think you can do better, if you already know database interactions or ORMs, or you don't trust database wrappers made by other people... Well, in any of those cases I don't even know why you're on this page, go on now, `git out --of:here` and go make some good applications, you don't need this!