firespace

KO | EN

gitlite — search

#javascript #python #android #python3 #java #go #golang #angular #game #react-native #react #django

★ 80 Open GitHub ↗

A small and simple library for the firebase realtime database

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p>&nbsp;</p>
<p align='center'>A simple space for Firebase</p>
<p>&nbsp;</p>

## Introduction

Firespace is for developers who want to quickly develop applications using Firebase, without all of the overhead. Currently only targeting the firebase real time database. 
**1kb gzipped!**

```
npm install @cvr/firespace
```

```
yarn add @cvr/firespace
```

**Step 1 - Set the firebase config in your root file**

```js
import { setConfig } from '@cvr/firespace';

setConfig({
    apiKey: '<APIKEY>',
    databaseURL: '<DATABASEURL>',
});

// you can also extend it
import 'firebase/auth';

const firebase = setConfig({
    apiKey: 'xx',
    databaseURL: 'xx',
    authDomain: 'xx',
});

const auth = firebase.auth();
```

**Step 2 - Use it**

```js
import { useSpace } from '@cvr/firespace';

export default function App() {
    const [todos, space] = useSpace('todos');

return (
        <div>
            <h1>Todo</h1>
            <AddTodo space={space} />
            <Todos todos={todos} space={space} />
        </div>
    );
}

function Todos({ todos, space }) {
    const todosList = Object.entries(todos || {});
    return (
        <div>
            {todosList.map(([id, todo]) => (
                <Todo key={id} id={id} todo={todo} space={space} />
            ))}
        </div>
    );
}

**Simple Api**

```js
import { useSpace } from '@cvr/firespace';

function Component() {
    const [todos, space] = useSpace('todos', ref => {
      //optionally, return custom ref
      return ref.orderByValue()
    });

const id = await space.add({ text: 'Install it', done: false });
    await space.update(id, { done: true });
    await space.delete(id);
    space.loading;
    space.error;
}
```

### Try it

[![Edit Firespace Example](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/firespace-example-uric7?fontsize=14)

firespace

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README