Skip to main content

Manual Setup

Creating database manually​

Sometimes using the plugin might be inconvenient. If this is your case, you can set everything up manually.

First of all, you need to create a database (more details here). During the creation process, you need to pass a correctly configured Data provider to the database:

import { createDatabase } from '@rattus-orm/core'
import { ReactSignalsDataProvider } from '@rattus-orm/react-signals'

const database = createDatabase({
  connection: 'entities',
  dataProvider: new ReactSignalsDataProvider()
}).start()

After this, you can use the database as usual: it's linked to the storage by the provider.

Integration with React​

The provider for React allows you to use the manually created database. To do this, you need to pass it in the props:

main.tsx
import React from 'react'
import ReactDOM from 'react-dom/client'
import App from './App.tsx'
import './index.css'
import { RattusProvider } from "@rattus-orm/react-signals";
import { myDatabase } from './database'

ReactDOM.createRoot(document.getElementById('root')!).render(
  <React.StrictMode>
    <RattusProvider database={ myDatabase }>
      <App />
    </RattusProvider>
  </React.StrictMode>,
)