🐐 CypherGoat (nojs) - instant exchange aggregator

This is the official repository of nojs.cyphergoat.com. This repository houses the official javascript free web-ui

All of the code is licensed under AGPL-v3

Installation

Requirements:

• Go
• Air for hot reloading
• Templ for templates

Clone the repository

git clone https://github.com/CypherGoat/web

cd web

Install dependencies

go mod tidy

Setup your environment:

export CYPHERGOAT_API_KEY="your_api_key_here"

export CYPHERGOAT_API_URL="api.cyphergoat.com" (optional)

OR via .env

echo "CYPHERGOAT_API_KEY=your_api_key_here" > .env

Note: The API key is only required for live API calls. You can still audit, review and modify the code without an API key.

Start the development server

air

If you head to http://localhost:4200 you should see cyphergoat up and running

Add support for a coin

To add support for a new coin, it must first be available on at least one of our partnered exchanges. You can view the list of supported exchanges here.

Once confirmed, follow these steps:

1. Edit the coins.json File
   Add your coin to the coins.json file. Use the following format as a template:

   {
     "ticker": "xmr",
     "name": "Monero",
     "network": "xmr",
     "isStable": false,
     "icon": "icons/xmr.webp",
     "min": 0
   }

Note: you should leave the min as 0 and it will be completed by our automated system.

2. Add the Coin Icon

Upload the coin’s logo (preferably from coingecko) to the icons folder

API intergration

CypherGoat requires an API key for fetching exchange rates and executing trades. The API provides endpoints for

• Fetching estimates
• Creating transactions
• Tracking transaction status

See our API documentation at api.cyphergoat.com

You can request an api key sending us an email to support@cyphergoat.com or by submitting this form