DjedAlliance / StablePay

1 stars 1 forks source link

Building DJED-SDK #1

Open Tanya-ruby opened 2 months ago

Tanya-ruby commented 2 months ago

The StablePay SDK will include DJED-SDK as a dependency to fetch stablecoin prices seamlessly.

DJED-SDK is designed to facilitate the integration and deployment of Djed across various projects, eliminating the need for code duplication. By using DJED-SDK, developers can easily incorporate Djed functionalities into any development environment, such as Vite or React. The library simplifies the process of fetching prices and addresses through straightforward import statements, ensuring a smooth integration experience.

This issue tracks the tasks required to build the Djed-SDK, which includes setting up Rollup and refactoring the code into modules to ensure a clean and maintainable project structure.

Checklist:

  1. Set Up Rollup

    • [x] Install Rollup and necessary plugins for Djed-SDK
    • [x] Create rollup.config.mjs file tailored for Djed-SDK
    • [x] Test Rollup configuration by building the Djed-SDK project
  2. Refactor Code into Modules

    • [x] Identify core functionalities of Djed-SDK to be modularized[IN PROGRESS]
    • [x] Create separate module files for each Djed-SDK functionality[IN PROGRESS]
    • [ ] Update import/export statements in Djed-SDK accordingly
    • [ ] Ensure all Djed-SDK modules are correctly integrated
  3. Testing and Validation

    • [ ] Write unit tests for each Djed-SDK module
    • [ ] Perform integration testing for Djed-SDK
    • [ ] Validate the final build output of Djed-SDK
    • [ ] Ensure that SDK is tested locally using npm-link after each module is constructed [CONTNIUOUS EXECUTION]
  4. Documentation

    • [ ] Update README.md with new setup and usage instructions for Djed-SDK
    • [ ] Document each Djed-SDK module with examples
  5. Continuous Integration

    • [ ] Set up CI pipeline to automate Djed-SDK builds and tests
    • [ ] Ensure the CI pipeline runs on each pull request for Djed-SDK
  6. Publishing

    • [ ] Update version in package.json
    • [ ] Build the final version of Djed-SDK
    • [ ] Publish the library to npm

This will ensure that the Djed-SDK is properly built, modularized, tested, documented, integrated with continuous integration workflows, and published for use.

ceilican commented 2 months ago

Nice plan, @Tanya-ruby !