https://github.com/rustbase/rustbase-js
A Javascript/Typescript Rustbase driver
https://github.com/rustbase/rustbase-js
javascript nodejs rustbase typescript
Last synced: 2 months ago
JSON representation
A Javascript/Typescript Rustbase driver
- Host: GitHub
- URL: https://github.com/rustbase/rustbase-js
- Owner: rustbase
- License: mit
- Created: 2022-08-30T13:35:39.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-01T23:45:47.000Z (over 3 years ago)
- Last Synced: 2025-02-28T01:01:48.880Z (over 1 year ago)
- Topics: javascript, nodejs, rustbase, typescript
- Language: TypeScript
- Homepage:
- Size: 142 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rustbase JS
A driver to use Rustbase with NodeJS
# Installation
```bash
npm install rustbase-js
```
# Usage
```js
const { connect } = require('rustbase-js');
const rustbase = connect("rustbase://:23561/supercooldatabase");
```
## With username and password
You can also connect to a Rustbase database with a username and password. Just add them to the URL.
```js
const rustbase = connect("rustbase://username:password@:23561/supercooldatabase");
```
## With SSL
You can also connect to a Rustbase database with SSL.
```js
const rustbase = connect("rustbase://username:password@:23561/supercooldatabase", {
tls: true,
});
```
# Contribute
## Prerequisites
- **pnpm**: We use pnpm as our package manager. You can install it with `npm install -g pnpm`.
## Setup
1. Clone the repository: `git clone https://github.com/rustbase/rustbase-js`
2. Enter the directory: `cd rustbase-js`
3. Install dependencies: `pnpm install`
# License
[MIT License](/LICENSE)