Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Simple News aggregator for all things algorand

ericsharma/Algorand-at-a-Glance

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Algorand at a Glance

A customized Glance dashboard for the Algorand ecosystem. This dashboard aggregates news, repositories, videos, and community content all in one place to keep you updated on everything Algorand.

Features

  • Repository Tracking: Monitor key Algorand Foundation repositories including algokit-cli, puya, puya-ts, and Algorand-Rust-FFIs
  • Video Feeds: Stay updated with the latest videos from Algodevs, Algorand Foundation, and Awesome Algorand channels
  • Community Content: Follow discussions from AlgorandOfficial, Algorand, Tinyman, VestigeFi, and FolksFinance subreddits
  • Custom Theming: Algorand-themed color scheme with custom CSS styling

Quick Start

Prerequisites

  • Docker and Docker Compose installed on your system
  • Internet connection for fetching external content

Running the Dashboard

  1. Clone this repository:

    git clone https://github.com/ericsharma/Algorand-at-a-Glance.git
    cd Algorand-at-a-Glance
  2. Create a .env file with your GitHub token:

    cp .env.example .env
    # Edit .env and replace 'github_pat_your_token_here' with your actual GitHub Personal Access Token
  3. Start the dashboard using Docker Compose:

    docker-compose up -d
  4. Open your browser and navigate to http://localhost:8080

Configuration

The dashboard configuration is managed through YAML files in the config/ directory:

  • glance.yml - Main configuration file with theme settings and page includes
  • Algorand.yml - Page layout and widget definitions for the Algorand dashboard

Customizing the Dashboard

You can modify the dashboard by editing the configuration files:

  • Add/Remove Repositories: Edit the repository widgets in config/Algorand.yml
  • Change Video Channels: Update the YouTube channel IDs in the video widgets
  • Modify Subreddits: Add or remove subreddit widgets for different communities
  • Theme Customization: Adjust colors and styling in glance.yml and assets/user.css

Widget Types

The dashboard includes several widget types:

  • repository - GitHub repository information and statistics
  • videos - YouTube channel video feeds
  • reddit - Subreddit post feeds with thumbnails

File Structure

.
├── README.md
├── docker-compose.yml          # Docker Compose configuration
├── config/
│   ├── glance.yml             # Main Glance configuration
│   └── Algorand.yml        # Algorand dashboard layout
└── assets/
    └── user.css               # Custom CSS styling

Environment Variables

The dashboard requires a GitHub Personal Access Token to fetch repository data:

  • GITHUB_TOKEN: Your GitHub Personal Access Token with public_repo scope

Create your token at: https://github.com/settings/tokens

Security Note

  • Keep your tokens secure and don't commit them to version control
  • Use tokens with minimal required permissions (public_repo scope only)
  • Regularly rotate your access tokens

Contributing

Feel free to submit issues and pull requests to improve the dashboard configuration or add new Algorand-related content sources.

License

This project uses the Glance dashboard application. Please refer to the Glance project for its licensing terms.

About

Simple News aggregator for all things algorand

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published