Skip to content

haroonwaves/ramifyjs

Repository files navigation

Ramify JS

Reactive, in-memory database for in-process JavaScript applications.

Ramify JS is environment-agnostic—built for the browser, Node.js, and Edge runtimes. It provides a lightweight, type-safe data store with live query observation for building reactive applications.

[!IMPORTANT] Ramify JS is not a durable database. It is designed for in-process data management, request-scoped caching, and transient state. Data is lost when the process or page is terminated.

Documentation

Ramify JS - Main documentation

Benchmark - Benchmark results

Development

This is a monorepo managed with pnpm workspaces.

# Install dependencies
pnpm install

# Build all packages
pnpm build

# Run type checking
pnpm type-check

# Run linting
pnpm lint

# Format code
pnpm format

# Run benchmarks (default: 100,000 records)
pnpm benchmark

Contributing

Fork the Project

Branching Strategy

  • Feature branches: feature/*
    git checkout -b feature/YOUR-BRANCH-NAME
  • Bug fix branches: fix/*
    git checkout -b fix/YOUR-BRANCH-NAME

Commit Message Format

All commits MUST follow this format:

<gitmoji> type(scope): subject

[optional body]

Examples

✨ feat(core): support for reactive queries
🐛 fix(react): infinite loop in useLiveQuery
📝 docs(app): update query api documentation

Development Workflow

  1. Create your Feature Branch git checkout -b feature/YOUR-BRANCH-NAME from the main branch
  2. Push to the Branch git push origin feature/YOUR-BRANCH-NAME
  3. Open a Pull Request against the main branch

License

LICENSE

About

Reactive, in-memory database for in-process JS applications

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published