Giter Club home page Giter Club logo

simple-wildduck's Introduction

Simple WildDuck

Simple WildDuck is a free and open-source wrapper for the WildDuck API. It simplifies API requests by providing well-documented TypeScript functions, making it easy to integrate WildDuck into any project.

Based completely on the existing API: https://docs.wildduck.email/api/

Basic Usage

import wd from "@absolit/simple-wildduck";

// initial setup, only have to do once
wd.wdInit({
	baseUrl: "https://www.your-wildduck-server.com",
	accessToken: "my-access-token",
	xAccessToken: "HeaderXAccessToken",
});

// simply make a request as such - note you will receive headers as well as data
const users = await wd.getUsers({ limit: 10 });

// reap the data rewards
if (users.data.success && users.data.results.length > 0) {
	console.log(users.data.results[0].address);
}

Project Structure

  • src/ -> All source code goes here
  • src/models -> Models that can be used everywhere goes here
  • src/requests -> All WildDuck request endpoints
    • src/requests/.../index.ts -> Exports all request functions
    • src/requests/.../config.ts -> Config to be applied to all requests
    • src/requests/.../models.ts -> All models used in related requests
    • src/requests/.../get.ts -> All GET request functions
    • src/requests/.../delete.ts -> All DELETE request functions
    • src/requests/.../post.ts -> All POST request functions
    • src/requests/.../put.ts -> All PUT request functions
  • src/setup -> Module setup, required functions when imported into your project

MeetingPal - Simplify Voting in Meetings

MeetingPal is a user-friendly app that allows for transparent voting during online, hybrid, or in-person meetings. This revolutionary software can be used for community schemes, professional bodies, associations, or trusts as it enables attendees to vote securely from anywhere in the world using only a mobile device. Enhance your meeting experience with MeetingPal.


simple-wildduck's People

Contributors

kmmalpha avatar weebnetsu avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

job-offerz

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.