Giter Club home page Giter Club logo

add-couchdb-backend's Introduction

Add CouchDB Backend

Add CouchDB and PouchDB to your local development environment.

Installation

  1. Install Docker and Node.js

  2. Create a new app project:

    npm create vite
  3. Add CouchDB as a backend:

    npx add-couchdb-backend
  4. Add PouchDB to the frontend:

    npm install pouchdb

Usage

  • Run npm run backend to start the backend

  • Open the CouchDB backend at http://localhost:5984/_utils/

    • Login with username root and password root
  • Synchronize the database with the frontend:

    // Import PouchDB
    import '../node_modules/pouchdb/dist/pouchdb.min.js'
    
    // Configure the local and remote databases
    const db = new PouchDB('development')
    const dbRemote = new PouchDB('http://localhost:5984/development')
    
    // Synchronize both databases
    db.sync(dbRemote, { live: true, retry: true })

How it works

  • no dependency will be added to the repository (only PouchDB itself)
  • you have full control of all source files for fine tuning
  • running npx add-couchdb-backend will download the package in a cache folder
    • the package will create a docker/ folder with the Dockerfile
    • the package will create a docker-composer.yml file to configure the container setup
    • the package will add a backend script to the package.json file

Support

Report bugs in the issues list.

Maintainer

  1. Commit changes with an issue (closure) reference
  2. Run npm version patch | minor | major and push changes
  3. Let the workflow manage the release to GitHub and NPM

add-couchdb-backend's People

Contributors

scriptpilot avatar

Watchers

 avatar

add-couchdb-backend's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.