Clorio Browser Extension

Welcome to Clorio, a modern, secure, and user-friendly browser extension for the Mina Protocol!

In the evolving landscape of Web3, Clorio stands as a gateway to the Mina ecosystem. It allows users to manage accounts, send transactions, and interact with zero-knowledge applications directly from their browser. Clorio is designed with a focus on security, simplicity, and a seamless user experience.

Getting Started 🚀

Prerequisite 📌

• Bun (v1.2.13 or higher)
• Node.js (v18 or higher)

Installation 💻

Make sure you're on the latest Bun version.

1. Install the dependencies:

   bun install

   Note: If you encounter issues, you can try npm install --legacy-peer-deps.

2. Configure environment variables:

   From the root directory, create a .env file (copy .env.example if available) and adjust the variables:

   VITE_API_URL=https://api.clorio.client

3. Build the extension:

   bun run build

Structure 🏗️

This repository contains the source code for the Clorio browser extension.

• src
  • api - API clients and Axios configuration.
  • components - Reusable UI components (Wallet, Settings, etc.).
  • hooks - Custom React hooks.
  • lib - Utilities, crypto functions, and validations.
  • pages - Main application pages (Dashboard, Send, etc.).
  • popup - Extension entry point.
  • stores - Global state management using Zustand.
  • styles - Global CSS and Tailwind configuration.

Development 🛠️

Set up the development server for the extension:

• Chrome / Chromium:

  bun run dev

• Firefox:

  bun run dev:firefox

Testing 🧪

• Run linter:

  bunx eslint .

• Run unit tests:

  bunx vitest

Contributing 🤝

We welcome contributions! Please feel free to open issues or submit pull requests to improve Clorio.

1. Fork the repository.
2. Create a branch for your feature (git checkout -b feature/NewFeature).
3. Commit your changes (git commit -m 'Add NewFeature').
4. Push the branch (git push origin feature/NewFeature).
5. Open a Pull Request.

Links 🌍

• Clorio Website - The official website of Clorio.
• Mina Protocol - The world's lightest blockchain.