Skip to content

SOuLSanctuary/SOuL

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SOuL Sanctuary/ ├── README.md ├── program/ # Solana smart contracts │ ├── src/ │ │ └── main.rs │ └── Cargo.toml ├── app/ # Frontend application │ ├── src/ │ │ ├── components/ │ │ ├── pages/ │ │ └── utils/ │ ├── public/ │ └── package.json ├── contracts/ # Token contracts │ ├── soul-token/ │ └── lst-tokens/ └── docs/ # Documentation ├─ └── tokenomics/

SOuL Sanctuary: Blockchain Environmental Impact Platform

A gamified sustainability platform that incentivizes environmental conservation through blockchain technology and interactive gameplay.

Features

Environmental Impact Tracking

  • Real-time carbon offset monitoring
  • Water conservation metrics
  • Biodiversity scoring system
  • Renewable energy contribution tracking

Gamification & Rewards

  • Achievement-based progression system
  • Community leaderboards
  • Team competitions
  • Blockchain-verified rewards

Interactive Visualization

  • Dynamic impact charts
  • Progress tracking
  • Community contribution metrics
  • Historical trend analysis

Social Features

  • Team collaboration
  • Achievement sharing
  • Community challenges
  • Global impact rankings

Getting Started

Prerequisites

  • Node.js (v16 or higher)
  • npm or yarn
  • Solana CLI tools

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/soul-sanctuary.git
cd soul-sanctuary
  1. Install dependencies:
npm install
  1. Set up environment variables: Create a .env file with:
REACT_APP_WS_URL=your_websocket_endpoint
REACT_APP_SOLANA_NETWORK=your_solana_network
JWT_SECRET=your_jwt_secret
VERIFICATION_API_KEYS=your_api_keys
  1. Start the development server:
npm start

Project Structure

Components

  • Dashboard/
    • RewardsPanel: Manages environmental rewards and achievements
    • LeaderboardPanel: Community rankings and impact metrics
    • AchievementModal: Interactive achievement celebrations
    • ImpactVisualization: Environmental data visualization

Hooks

  • useImpactCalculator: Environmental impact calculations
  • useEnvironmentalVerification: Action verification logic

Security

  • JWT-based authentication
  • Blockchain verification
  • Secure WebSocket connections
  • Environmental action validation

Testing

Run the test suite:

npm test

Key test areas:

  • Component rendering
  • Impact calculations
  • Data visualization
  • User interactions
  • Achievement system

Deployment

Production Environment

The production environment is hosted on Vercel with the following configurations:

Required Environment Variables

REACT_APP_WS_URL=wss://api.soulsanctuary.io
REACT_APP_SOLANA_NETWORK=mainnet-beta
REACT_APP_API_URL=https://api.soulsanctuary.io
REACT_APP_SOLANA_RPC_HOST=https://api.mainnet-beta.solana.com
REACT_APP_SENTRY_DSN=[your-sentry-dsn]

Deployment Process

  1. Push changes to the main branch
  2. GitHub Actions will automatically:
    • Run tests
    • Create production build
    • Deploy to Vercel
    • Create Sentry release

Monitoring

  • Error tracking: Sentry (https://sentry.io)
  • Performance monitoring: Vercel Analytics

Security

  • SSL/TLS encryption enabled
  • Security headers configured
  • CSP policies implemented
  • Regular security audits

Tech Stack

  • Frontend: React.js
  • Blockchain: Solana Web3.js
  • State Management: React Hooks
  • Testing: Jest
  • Visualization: Recharts
  • Authentication: JWT
  • Real-time: WebSocket

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Commit your changes
  4. Push to the branch
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • Solana Foundation
  • Environmental Conservation Partners
  • Open Source Contributors

Support

For support, please open an issue in the GitHub repository or contact the development team.