A free and open source web-based tool that serves as a graphical user interface (GUI) for easily creating and sending Algorand transactions without the need for software development knowledge.
- 🌐 Websites
- ✨ Features
- 💬 Supported languages
- 💻 Setting up and running locally
- 🛠️ Installation for development
- 🤝 Contributing
- 🏆 Acknowledgments
You can use txnDuck for free (excluding any Algorand network fees) at the following websites:
Production: https://txnduck.vercel.app
Preview: https://txnduck-preview.vercel.app
The Production website hosts the latest stable release (the stable branch)
where are all of the features are considered complete and stable. On the other
hand, the Preview website usually hosts the unstable version (the main branch)
with the latest developments, so it may have incomplete and/or unstable features
that have yet to be released. There may be times when both websites are the
same.
- Build and send a transaction to transfer Algos, create a token or NFT, call an application (smart contract), etc.
- Import a transaction file to sign or send
- Export to a signed/unsigned transaction file
- Specify custom Algod node
- FUTURE: Build transaction groups (atomic transactions)
The UI (user interface) for txnDuck has multiple supported languages. However, not all of the languages have the same amount of support. The translations for some of the supported languages may be incomplete or contain errors due to being a machine translation.
If you want to help by adding or fixing a translation, read about how you can do so in the Contributing Guidelines.
| Language | Completeness | Machine translated? |
|---|---|---|
| English | Full | No |
| Spanish | Full | Yes |
Instead of using one of the official txnDuck websites, you can choose to download the source code and run the software locally on your own computer that does not rely on an external website.
- Access to your machine's command line interface (CLI), such as Terminal, PowerShell or Command Prompt
- Node.js version 18.18.0 or higher installed. Version 20.0.0 or higher is recommended.
- Yarn package manager installed.
Version 2.0.0 or higher, version 4.0.0 or higher is recommended.
NOTE: If you have Yarn 1.x.x installed, you can install and switch to Yarn 2.0.0 or higher by running
corepack enable && yarn set version berry
-
Download the latest source code.
- Production (
stablebranch): https://github.com/No-Cash-7970/txnDuck/archive/refs/heads/stable.zip - Preview (
mainbranch): https://github.com/No-Cash-7970/txnDuck/archive/refs/heads/main.zip
- Production (
-
Unzip the downloaded source code. You should now have a new folder that contains a bunch of files and folder, which include "public" and "yarn.lock".
-
Open the CLI and go to the folder created in step #2 by running the following in the CLI. Of course, replace
PATH/TO/SOURCE_CODE/FOLDERwith the actual path to the folder.cd PATH/TO/SOURCE_CODE/FOLDER -
Install the source code dependencies.
yarn workspaces focus --all --production
-
Build the source code.
yarn build
-
Run the web server.
yarn start
-
Open a web browser and go to http://localhost:3000 to start using your local txnDuck! 🎉 The web server must be running in the CLI (Command Line Interface) to use your local txnDuck.
-
(Optional) If you are finished using your local txnDuck, stop the web server by closing the CLI window or by pressing Ctrl+C (or Cmd+C on Mac) while in the CLI. You can start the web server again by following Steps #6 and #7.
- Make sure the web server is not running. Stop the server if it is. Refer to step #8 in the installation instructions.
- Delete the source code folder. (The folder created in Step #2 of the installation instructions)
- OPTIONAL: Uninstall the software listed in the requirements for local setup if you do not need them for something else.
Some time after installing the local setup, a new version of txnDuck may be released. It is recommended that you update to the latest version to have the latest features and bug fixes.
- OPTION #1: Uninstall the old version by following Steps #1 and #2 of the
uninstallation instructions.
OPTION #2: Keep the old version and rename the source code folder for the old version.
OPTION #3: Keep the old version without renaming its source code folder. When installing the new version, use a different name for the new version's source code folder. - Make sure the web server is not running. Stop the server if it is. Refer to step #8 in the installation instructions.
- Follow the installation instructions again. Make sure you download the latest source code.
Refer to the Developers Documentation for instructions on how to install, update or uninstall the development environment.
Contributions are highly welcomed and appreciated. Every little bit of help counts, so do not hesitate! Please read the Contributing Guidelines to learn how to contribute to this project.
- SilentRhetoric - Proposed the idea of a transaction builder for Algorand
- Wes - Recommended the name "txnDuck"