aircode

AirCode NodeJS SDK

• AirCode NodeJS SDK is used in AirCode Application. It can provide users with database, files and other functions.

ChangeLog

SDK Development Guide

This guide will walk you through the entire process of SDK development, using the creation of a database API as an example.

• Step 1: Confirm Requirements
  • Define product functionalities. Be careful with public releases as they are irreversible.
• Step 2: Development
  • Start developing post requirement confirmation. Enable static checking for error prevention.
• Step 3: Setup Local Environment(Optional)
  • Check thetests/chore-debug directory. If auth-file.json and endpoint.json are missing, create them in the same directory from Tools Repo
• Step 4: Test Cases
  • Write and pass test cases for each new feature.
• Step 5: Execute Tests
  • Run npm run test or npm run test:single ./tests/db.test.js to test your feature.
• Step 6: Update Changelog and Version
  • Modify the changelog.md and update the version using npm version patch|minor|major.
• Step 7: Create Pull Request
  • After completing and testing changes, create a pull request and await review.
• Step 8: Draft New Release
  • Follow images 8.1 and 8.2 to create a new release. This auto-triggers all release actions.
  • 8.1
  • 8.2