search

DataFire / OneDB

OneDB lets you create cloud-enabled apps without having to worry about or pay for backend infrastructure.
https://one-db.org
MIT License
57 stars 10 forks source link

readme

OneDB

Travis NPM version license Join the chat at https://gitter.im/One-DB/Lobby

The documentation for OneDB is at docs.one-db.org

OneDB Logo

Connect your frontend to the cloud. For free, forever.

OneDB is an open source decentralized backend - it handles user authentication, data storage, and validation, so you can focus on creating a beautiful user interface.

Anyone can host a OneDB instance, and end-users can decide where they want to store their data. This means end-users have complete control and ownership over their data. And by utilizing the existing network of OneDB instances, you can deploy your app for free, forever.

We provide a OneDB instance at one-db.datafire.io which is free for developers. End-users can store up to 10MB of data before getting charged.

You can read more about OneDB, check out the documentation, or continue reading to learn more about the code in this repository.

Repository Contents

This repository contains:

Build an App

Building apps on OneDB is free and easy. Just create a data model, write your frontend, and the existing network of OneDB instances will take care of all the data validation and storage.

Check out the Hello World documentation or the sample apps to get started.

If you build an app, let us know and we'll add you to the list of OneDB apps

Host an Instance

The full documentation for hosting an instance is on docs.one-db.org

Help us expand the OneDB network by hosting an instance. You'll need:

If you host a public instance, let us know and we'll add you to the list of known hosts

Installation and Setup

Install the server:

npm install -g onedb-cli

Create your settings in OneDB.yml:

mongodb: "mongodb://localhost:27017"
jwtSecret: "thisisasecret"
host: "https://onedb.example.com"

And start the server:

onedb serve --port 3000

Contribute

Contributions are welcome! Check out the roadmap to learn how you can help, or open an issue if there's a feature you'd like to see.

If you're working on a major change, be sure to let us know ahead of time.