Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.8 KB

README.md

File metadata and controls

39 lines (26 loc) · 1.8 KB

Compendex Tools

Compendex Tools is an open-source project provided by the Compendium team. The project's goal is to provide a full suite of trading tools that make life in the markets simpler. The project is continually upgraded, and users are welcome to clone the repository or open pull requests. image

Getting Started

To get started with Compendex Tools, follow these steps:

  1. Clone the project from https://github.com/CompendiumFi/Compendex-Interface
  2. Install the project dependencies by running npm install --force.
  3. Start the project with npm run dev.

Note: To run the project smoothly, you need to provide the following environment variables:

NEXT_PUBLIC_SOLANA_RPC_ENDPOINT="" #public solana rpc
NEXT_PUBLIC_USDT_REFERRAL="ZcHd98AKDwFkB72X5r77FUusCHf41NeJwZUub94tUWu" #usdt referral address
NEXT_PUBLIC_USDC_REFERRAL="92Q3GzZ2JkGoiQzUSgpS6YDv9ZUG161GpNHPf2TW8vkE" #usdc referral address
NEXT_PUBLIC_DATA_FEED_ENDPOINT="" #trading view chart data feed
NEXT_PUBLIC_WEBSITE_TITLE="Compedex Trading Terminal" # project title
NEXT_PUBLIC_DISPLAY_TRADING_VIEW=2 # one if you want to display Trading view first 
NEXT_PUBLIC_COINGECKO_PRO_KEY="" # coingecko pro api key`
NEXT_PUBLIC_SOLSCAN_TOKEN="" # solscan api token 

If you encounter any problems, please open an issue or reach out to us on Discord.

Contributing

Compendex Tools is an open-source project, and we welcome contributions from the community. If you want to contribute to the project, please open a pull request.

License

Compendex Tools is licensed under the MIT License. See LICENSE for more information.