An open API service indexing awesome lists of open source software.

https://github.com/blockful/trustful-stellar


https://github.com/blockful/trustful-stellar

Last synced: 4 months ago
JSON representation

Awesome Lists containing this project

README

          


Trustful Stellar Logo

# 🌟 Trustful Stellar

**Transform Your Stellar Achievements Into Verifiable On-Chain Reputation**

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
[![Node.js](https://img.shields.io/badge/Node.js-18.x-green.svg)](https://nodejs.org/)
[![Next.js](https://img.shields.io/badge/Next.js-14.2.4-black)](https://nextjs.org/)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue)](https://typescriptlang.org/)
[![Tailwind CSS](https://img.shields.io/badge/Tailwind%20CSS-3.4.1-38B2AC)](https://tailwindcss.com/)
[![Stellar](https://img.shields.io/badge/Stellar-Network-7B2CBF)](https://stellar.org/)

[πŸš€ Live Demo](#) β€’ [πŸ“– Documentation](#) β€’ [πŸ› Report Bug](https://github.com/blockful-io/trustful-stellar/issues) β€’ [✨ Request Feature](https://github.com/blockful-io/trustful-stellar/issues)

---

## 🎯 What is Trustful Stellar?

**Trustful Stellar** is a cutting-edge decentralized application (dApp) that revolutionizes on-chain reputation for the **Stellar ecosystem**. We transform your blockchain achievementsβ€”like **Stellar Quest badges** and ecosystem contributionsβ€”into verifiable, transparent, and actionable reputation scores.

### πŸ’‘ The Problem We Solve

In decentralized communities, proving your contributions and expertise is challenging. Traditional reputation systems are centralized and opaque. Trustful Stellar bridges this gap by creating a **trustless, verifiable reputation system** that communities can use for:

- πŸ—³οΈ **Governance voting** with weighted reputation
- πŸ’° **Grant allocation** based on proven track record
- πŸ‘₯ **Role assignments** with verified credentials
- 🀝 **Community participation** with transparent standing

---

## ✨ Key Features

### πŸ”— **Wallet Integration**

- **Stellar Wallet** (Albedo) for achievement retrieval

### πŸ›‘οΈ **Verifiable Reputation**

- On-chain attestation and verification

### 🏘️ **Community-Driven**

- Multiple community contexts supported

### 🎨 **Modern UI/UX**

- Intuitive navigation and feedback

---

### πŸ› οΈ **Core Technologies**

| Category | Technologies |
| -------------------- | ---------------------------------------------- |
| **Frontend** | Next.js 14, React 18, TypeScript, Tailwind CSS |
| **State Management** | Zustand, React Query, React Hook Form |
| **Blockchain** | Stellar SDK, Albedo |
| **UI/UX** | Lucide React, React Hot Toast, React Tooltip |
| **Development** | Storybook, ESLint, Prettier, PostCSS |

---

## πŸš€ Quick Start

### πŸ“‹ Prerequisites

- **Node.js** 18.x or higher
- **npm** or **yarn**
- **Git**

### ⚑ Installation

```bash
# Clone the repository
git clone https://github.com/blockful-io/trustful-stellar.git

# Navigate to project directory
cd trustful-stellar

# Install dependencies
npm install

# Copy environment file
cp .env.example .env
```

### πŸ”§ Environment Setup

Create your `.env` file with the following variables:

```env

NEXT_PUBLIC_ENV=
NEXT_PUBLIC_API_URL=
NEXT_PUBLIC_RPC_URL=
NEXT_PUBLIC_NETWORK=
NEXT_PUBLIC_FACTORY_CONTRACT_ID=

```

### 🎬 Running the Application

```bash
# Start development server
npm run dev

# Open your browser
# Navigate to http://localhost:3000
```

### πŸ“š Component Development

```bash
# Start Storybook for UI development
npm run storybook

# Open component library
# Navigate to http://localhost:6006
```

---

## πŸ“– Usage Guide

### 1️⃣ **Connect Your Wallets**

- Link your Stellar wallet (Albedo) to access your achievements

### 2️⃣ **Verify Your Reputation**

- Trustful Stellar registers user reputation

### 3️⃣ **Join Communities**

- Browse available reputation contexts
- See how your score applies in different communities

---

## πŸ—‚οΈ Project Structure

```
trustful-stellar/
β”œβ”€β”€ πŸ“ src/ # Source code
β”‚ β”œβ”€β”€ πŸ“ components/ # Reusable UI components
β”‚ β”œβ”€β”€ πŸ“ hooks/ # Custom React hooks
β”‚ β”œβ”€β”€ πŸ“ lib/ # Utility libraries
β”‚ └── πŸ“ types/ # TypeScript definitions
β”œβ”€β”€ πŸ“ app/ # Next.js App Router
β”œβ”€β”€ πŸ“ public/ # Static assets
β”œβ”€β”€ πŸ“ .storybook/ # Storybook configuration
β”œβ”€β”€ πŸ“„ tailwind.config.ts # Tailwind configuration
└── πŸ“„ next.config.mjs # Next.js configuration
```

---

## πŸ”„ Available Scripts

| Command | Description |
| ------------------------- | --------------------------------- |
| `npm run dev` | πŸƒβ€β™‚οΈ Start development server |
| `npm run build` | πŸ—οΈ Build production application |
| `npm run start` | πŸš€ Start production server |
| `npm run lint` | 🧹 Run ESLint for code quality |
| `npm run storybook` | πŸ“š Start Storybook development |
| `npm run build-storybook` | πŸ“¦ Build Storybook for deployment |

---

## 🀝 Contributing

We love contributions! Here's how you can help make Trustful Stellar even better:

### πŸ”₯ Quick Contribution Steps

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

### πŸ“‹ Development Guidelines

- βœ… Use TypeScript for type safety
- βœ… Follow existing code patterns and structure
- βœ… Add comments and documentation
- βœ… Write tests when applicable
- βœ… Use semantic HTML and ARIA attributes
- βœ… Leverage Tailwind CSS classes from `globals.css`

### πŸ› Bug Reports & Feature Requests

Found a bug or have an idea? [Open an issue](https://github.com/blockful-io/trustful-stellar/issues) and let's discuss it!

---

## 🏒 About Blockful



**Built with ❀️ by [Blockful](https://blockful.io)**

We're passionate about building the future of decentralized technologies and creating tools that empower communities.

[🌐 Website](https://blockful.io) β€’ [🐦 X](https://x.com/blockful_io) β€’ [πŸ’Ό LinkedIn](https://linkedin.com/company/blockful)

---

## πŸ“œ License

This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.

---

### 🌟 Star this repository if you found it helpful!

**Made with πŸ’œ for the Stellar Ecosystem**

[⬆️ Back to Top](#-trustful-stellar)