Getting started

NotoDB is a simple, serverless NoSQL database that lives on Amazon S3.

Because S3 does not allow for partial file updates, it's important to understand what NotoDB is, and what it's not.

NotoDB is great for applications that require high availability and have high read demands. NotoDB is not recommended for applications that require high-frequency, asynchronous writes, such as chat clients.

NotoDB is open source and runs on NodeJS 14+.

Installing NotoDB

Before using NotoDB, make sure you have access to an Amazon Web Services account and have an IAM user with API access (Access Key ID & Secret Access Key). Your IAM user will need the following permissions to your S3 bucket:

s3:ListAllMyBuckets 
s3:ListBucket 
s3:CreateBucket 
s3:DeleteBucket 
s3:GetObject 
s3:PutObject 
s3:DeleteObject

Get the latest code from:
https://github.com/audenhinton/notodb

Navigate to the root directory of your project and run the following:

npm install

To start the local server run the following:

npm run start

Your local instance of NotoDB will begin running on port 8080.
http://localhost:8080

While you are running a local instance of NotoDB, the server will still connect to remote Amazon S3 to access storage for data, which is in the cloud. Currently, there is not local support for the storage layer of NotoDB due to its dependency on Amazon S3.

See Authentication for information on how to connect to NotoDB.

See API Endpoints for information on how to connect using NotoDB Cloud.

Next articleUse cases