Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Building DJED-SDK #1

Open
5 of 18 tasks
Tanya-ruby opened this issue Jun 26, 2024 · 1 comment
Open
5 of 18 tasks

Building DJED-SDK #1

Tanya-ruby opened this issue Jun 26, 2024 · 1 comment

Comments

@Tanya-ruby
Copy link
Contributor

Tanya-ruby commented Jun 26, 2024

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

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

    • Identify core functionalities of Djed-SDK to be modularized[IN PROGRESS]
    • 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
Copy link
Contributor

Nice plan, @Tanya-ruby !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants