Development
Last updated
Was this helpful?
Last updated
Was this helpful?
The Javascript SDK wraps the æternity API exposed by. It aims to abstract the API, while still providing low-level access to it's endpoints, when necessary.
It uses the following Javascript technologies and principles:
(because Crockford is always right)
, using export
and import
using ES7 syntax, where applicable
Statelessness wherever possible
and the
Loose coupling of modules to enable
Convention over configuration
"Easy things should be easy, and hard things should be possible." --
Support for
module access, enabling tree-shaking
direct use in node scripts through bundling
direct use in browser <script>
tags through bundling
bundling through webpack
Clone the application
Make sure your editor/IDE can read and use the .editorconfig
file
aepp-sdk is built using npm. In order to build a production version, launch the build
command.
Note: If you experience errors during the building, you might need to install build tools for your OS.
Windows: Windows Build Tools
Ubuntu / Debian: Build Essential
Mac
This repository also includes a docker-compose file, to allow you to run your own æternity node locally. If you want to do so, from the root of the project:
Run docker-compose up node
Congrats! you're now running your own æternity node locally.
The WebPack compilation provides two different build artifacts in dist/
, one
for Node.js and one for browsers. When referencing aepp-sdk through any modern
build tooling, it should pick the right one automatically through the entry
points defined in package.json
.
aepp-sdk is transpiled to EcmaScript 5 through , using and is expected to work in any sufficiently new version of or modern web browser.
Start hacking (and don't forget to add for whatever you'll be building).
Apart from documenting features and code, there is also documentation automatically generated using for documenting TS files and for documenting examples and code partials.
Download from AppStore, then run
To test, launch the test
command. This will run 's tests locally.
In order to add a local development version of aepp-sdk to a project, npm link
can be used.