geekyants/geekymodel

GeekyModel - Opinionated State Container for Remote and Local Storage with a Database-like API powered by MobX

🗄 GeekyModel

⚠️️️️️ ⚠️️️️️ ⚠️️️️️ Not for production use ⚠️️️️️ ⚠️️️️️ ⚠️️️️️

What is 🗄 GeekyModel?

GeekyModel is an opinionated State Container with a Database-like API powered by MobX.

The Data Models can later be mapped to a Remote service like Firebase, REST API, GraphQL etc.

Features ⚡

• Build your front-end models without worrying about the back-end. GeekyModel works with LocalStorage by default.

• Offline First: Connect to any back-end at a later stage, like

  • Firebase / Firestore
  • GraphQL
  • REST APIs

• Write request and response middlewares to map the differences in the front-end and the back-end models.

• Built-in standard validation and option to add custom validators.

• Model Relationships: Relate models with References and Foreign Keys.

• Built-in Fake Data: Populate your UI with Fake Data automatically.

Getting started

yarn add geekymodel

OR

npm install geekymodel --save

Writing your first model

import { createModel } from "geekymodel";

const Todo = createModel({
  table: "todos",
  fields: ["caption", "isCompleted"]
});

Creating a new Todo

const newTodo = Todo.create();

newTodo.setField("caption", "Buy milk");
newTodo.setField("isCompleted", "false");

newTodo.save();

// newTodo.saving gets populated which is a MobX ObservableValue

Fetching all the todos and wiring with React

@observable
class TodoApp extends Component {

    componentWillMount() {
        this.todos = Todo.findAll();
    }

    render() {

        const { data, loading } = this.todos;

        if (loading)
            return <span>Loading</span>;

        return <ul>
            {data.map(item) => <li>{item.getField('caption')}</li>}
        </ul>
    }

}

Adding query params

const allCompleted = Todo.where("isCaption", "=", true).get();

Roadmap

• Model creation with Schema

• Convert to monorepo

• Injectable Transport Layer

• Connection

  • FakeConnection
    • Improve FakeConnection to request and response on Schema
    • WIP: Implement get(), find(), insert(), update() and delete() with FakeConnection()
  • LocalStorageConnection
  • RuntimeStorageConnection
  • RuntimeMiddlewareConnection
  • FirestoreConnection
  • GraphQLConnection
  • RestConnection

• Normalization

• Validation

• Middlewares:

  • Builder: For each method get(), find(), insert(), update() and delete()
  • Connection: Request and Response

• Namespace Global variables in Database

• Build script

• Middlewares

• Relationships

• Examples:

  • Todo app
  • Hacker news clone
  • Shopping cart

Decisions

• DatabaseSchema to be forwarded from top level to the connection

Open Questions

• How would it work with offline first database which syncs later?