Kassandra is a decentralized autonomous organization of decentralized finance that governs a protocol that allows the creation and management of tokenized crypto portfolios, bringing a new class of products to managers and investors.

Technology

This project was developed with the following technologies:

• React / Next.js
• TypeScript
• Styled-Components
• Ethers
• TanStack Query / React Query
• Big.js

Prerequisites

Before you begin, ensure you have the following software installed:

• Node.js >=18.x.x <=20.x.x
• Yarn

Environment Variables

This project requires certain environment variables to be set up in order to function properly. You can create a .env file in the root of the project and add the following variables:

# Example .env file

NEXT_PUBLIC_MASTER=1
NEXT_PUBLIC_BACKEND_KASSANDRA=https://backend.kassandra.finance/
NEXT_PUBLIC_NODE_ENV=public

# CoinGecko API keys - You only need to use one of these keys. 
# Be aware that the free key (COINGECKO_API_KEY) has usage limits.
COINGECKO_API_KEY=
COINGECKO_PRO_API_KEY=

# Optional
DATABASE_URL=
IRON_SESSION_PASSWORD=
NEXT_PUBLIC_WALLETCONNECT=
NEXT_PUBLIC_MORALIS_KEY=

Environment Variables Description

• NEXT_PUBLIC_BACKEND_KASSANDRA: URL of the backend used by the application. Example: https://backend.kassandra.finance/.
• NEXT_PUBLIC_NODE_ENV: Sets the execution environment. Example: public.
• COINGECKO_API_KEY: Free CoinGecko API key with limited access. You can obtain it by creating a free account. Learn more at CoinGecko API Documentation.
• COINGECKO_PRO_API_KEY: CoinGecko PRO API key. Learn more at CoinGecko PRO Documentation.
• DATABASE_URL (Optional): Connection URL to the database. Used only for user profiles.
• IRON_SESSION_PASSWORD (Optional): Password used to encrypt sessions. Used only for user profiles.
• NEXT_PUBLIC_WALLETCONNECT (Optional): Project ID for WalletConnect integration. Learn more at WalletConnect Cloud.
• NEXT_PUBLIC_MORALIS_KEY (Optional): Key used to fetch the user's NFT list in their profile. Learn more at Moralis API Documentation.

Installation

Follow the steps below to set up the Next.js application:

Clone the repository:

git clone https://github.com/KassandraFinance/kassandra-application.git

cd kassandra-application

# Installing the dependencies
yarn
 
# Running application
yarn dev

Contributing

We welcome contributions! Please check our contributing file for guidelines on how to report issues, submit pull requests.

License

This project is licensed under the GNU General Public License v3.0.

Discussion

For any concerns with the protocol, open an issue or visit us on Discord to discuss.

For security concerns, please email [email protected].