Skip to content

๐Ÿ”‹ Woovers is a in-memory NodeJS lightweight server focused on mimicking the Woovi/OpenPIX api easily without needing to have any active access key. In development.

Notifications You must be signed in to change notification settings

growly-group/woovers-js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

62 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

woovers-js

Welcome to Woovers

Woovers is a lightweight API simulator built with Bun and Express.
It mimics the core behavior of the Woovi/OpenPIX API, but without requiring official access keys or credentials.

The goal of this project is to provide a simple way to experiment with Pix-like flows in a single environment โ€” including:

  • Basic API endpoints and functionalities
  • QRCode generation (not real/valid Pix codes xD)
  • Webhook simulation
  • And more features under development

Important

Woovers is not affiliated with Woovi or OpenPIX.
Itโ€™s an unofficial, community-driven project with no guarantees of compatibility or support.
The implementation only mimics the official API superficially, without reproducing all the nuances or updated features.


๐Ÿ› ๏ธ Tech Stack

Woovers is powered by:

  • ExpressJS โ€“ Minimal and fast HTTP server
  • TypeScript โ€“ Type safety and developer experience
  • SQLite โ€“ Lightweight persistence out of the box
  • Bun โ€“ Modern runtime with blazing fast performance and package management

โš™๏ธ Requirements

Make sure you have installed:

  • Bun โ‰ฅ 1.2

๐Ÿš€ Getting Started

  1. Copy the environment configuration:

    cp .env.example .env
  2. Install project dependencies:

    bun install

    Note: While this project uses Bun as the runtime, you can also use other package managers like npm install/yarn install/pnpm install to manage dependencies if preferred.

  3. Start the application:

    bun start

By default, the server runs at:
http://localhost:3000

You can update the port in your .env file.


Contributing

  1. Check or create an issue

    • Look at the open Issues to see if someone is already working on what you want.
    • If not, open a new issue to discuss your idea before starting.
  2. Fork the repository

    • Create your own copy of the project by forking this repo.
  3. Create a feature branch

    git checkout -b feat/my-feature
  4. Commit your changes

    git commit -m "feat: added my feature"
  5. Push to your fork and open a PR

    • Push your branch:
      git push origin feat/my-feature
    • Open a Pull Request to the main branch.
    • Assign one reviewer (preferably Scarlet xD).

About

๐Ÿ”‹ Woovers is a in-memory NodeJS lightweight server focused on mimicking the Woovi/OpenPIX api easily without needing to have any active access key. In development.

Resources

Stars

Watchers

Forks

Releases

No releases published

Contributors 6