Skip to content

MallarDev/dexie-presentation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dexie Presentation

It is a simple project to just show how Dexie works.

Dexie

What it is

Basically Dexie is a minimalistic but very powerfull wrapper for browser IndexedDB API.

Why Dexie

  • Usage: More than 17.000 repos using it

  • Easy to implement: This repo is a proof of how simple it is to use, you'll need only to declare your model like in db.js and do your business logic with it like i did in actions.js

Dependencies

  • Required
    • dexie: Gives all the functionality of the IndexedDB.
    • dexie-react-hooks: Updates query result whenever the database is updated.
  • Optional
    • @emotion/react: Styling
    • @emotion/styled: Styling
    • @mui/icons-material: Icons
    • @mui/material: Components/styling with Material UI
    • vite: This example is build on top of Vite
    • @vitejs/plugin-react: This example uses React, so Vite needs this plugin to work

Testing

Server

This project is hosted for free thanks to Vercel <3.

So you can access and test it here.

Locally

Dependencies

To run this project locally you'll need the dependencies around Vite and React, which is NodeJS and NPM, and i recommend to use NVM to manage their version.

Steps

  1. Clone this repo using one of those 2 commands in your preferred terminal:

    SSH:

    git clone [email protected]:MallarDev/dexie-presentation.git

    HTTPS:

    git clone https://github.com/MallarDev/dexie-presentation.git
  2. Now go to the created folder with:

    cd dexie-presentation
  3. Install the dependencies using:

    npm install
  4. Run the project:

    npm run dev
  5. Access the page on localhost.