---
title: "Deploy github-statcrab"
description: "GitHub profile stats for Readme file generated on the fly!"
category: "Other"
url: https://railway.com/deploy/github-statcrab
---

# Deploy github-statcrab

GitHub profile stats for Readme file generated on the fly!

**[Deploy github-statcrab on Railway](https://railway.com/template/github-statcrab)**

- **Creator:** Sam Gozman's Projects
- **Category:** Other
- **Total deploys:** 2

## Template content

### github-statcrab https://raw.githubusercontent.com/samgozman/github-statcrab/refs/heads/main/assets/icon.png

- **Image:** ghcr.io/samgozman/github-statcrab/server:latest
- **Health check:** /api/health
- **Public domain:** Yes

## Documentation

# Deploy and Host github-statcrab on Railway

github-statcrab is a Rust-based web server that generates dynamic SVG cards displaying GitHub user statistics and programming language usage. It leverages the GitHub API to present data in visually appealing formats for embedding in README files or web pages.

## About Hosting github-statcrab

Hosting github-statcrab involves deploying a Rust web server that connects to the GitHub API to fetch user data and generate SVG cards. The service requires a GitHub Personal Access Token for API authentication and includes built-in caching to optimize performance. The server exposes REST endpoints that return dynamic SVG cards displaying user statistics and top programming languages, making it perfect for embedding in GitHub profiles.

## Common Use Cases

- Display GitHub user statistics in personal README profiles
- Show top programming languages in project documentation
- Generate visual summaries of coding activity for portfolios

## Dependencies for github-statcrab Hosting

- GitHub Personal Access Token (with `repo` and `user` scopes)
- Docker runtime environment (handled automatically by Railway)

### Deployment Dependencies

- [GitHub Personal Access Token](https://github.com/settings/tokens)
- [Full Documentation and Examples](https://github.com/samgozman/github-statcrab?tab=readme-ov-file#github-statcrab)
- [Available Themes and Previews](https://github.com/samgozman/github-statcrab/blob/main/assets/css/themes/README.md)

### Implementation Details

After deployment, use the cards in your README:

```markdown
[![GitHub Stats](https://your-railway-domain.railway.app/api/stats-card?username=yourusername&theme=monokai)](https://github.com/samgozman/github-statcrab)

[![Top Languages](https://your-railway-domain.railway.app/api/langs-card?username=yourusername&layout=horizontal&theme=dracula)](https://github.com/samgozman/github-statcrab)
```

Required environment variable:
```env
GITHUB_TOKEN=your_github_personal_access_token_here
```

## Why Deploy github-statcrab on Railway?

Railway is a singular platform to deploy your infrastructure stack. Railway will host your infrastructure so you don't have to deal with configuration, while allowing you to vertically and horizontally scale it.

By deploying github-statcrab on Railway, you are one step closer to supporting a complete full-stack application with minimal burden. Host your servers, databases, AI agents, and more on Railway.

## Similar templates

- [Rocky Linux](https://railway.com/deploy/rocky-linux) — Hosted Rocky Linux 9 workspace with SSH and persistent storage. 🚀
- [Foundry Virtual Tabletop](https://railway.com/deploy/X5tR6G) — A Self-Hosted & Modern Roleplaying Platform
- [Letta Code Remote](https://railway.com/deploy/letta-code-remote) — Run a Letta Code agent 24/7. No inbound ports, just deploy.

Open this page in a browser: https://railway.com/deploy/github-statcrab