The Visit Counter API is a lightweight, self‑hostable service built in Rust that tracks website visits and generates customizable SVG counters. The backend is built with Rocket. It features a web interface built with Yew WebAssembly for badge management and administration.

• SVG Generator Module: All SVG-generation logic is contained in backend_visit_counter/src/svg_generator.rs.
• Web Interface: Yew WebAssembly frontend for badge management and administration.
• API Endpoints: RESTful API for counter operations and admin management.
• Persistent Storage: JSON-based storage with authentication for administrative operations.

Visit https://visitcounter.aichan.ovh/ to use the interactive badge generator interface. This web application allows you to customize your visit counter badge with a live preview and automatically generates the HTML code for you.

If you prefer to use the API directly, you can add an img tag to your site:

<img src="https://visitcounter.aichan.ovh/counter/YOUR_PAGE_NAME/svg?label=YOUR_TEXT&color=YOUR_COLOR&style=font-weight:bold;" alt="Visit Counter" />

• Page name: Don't forget to set it https://visitcounter.aichan.ovh/counter/YOUR_PAGE_NAME...
• label: The text shown to the left.
• style: Directly embed CSS in here. Something like ":root { --background-counter: red; }" would work.

(back to top)

The project is organized as follows:

visit_counter/ ├── backend_visit_counter/ # Rocket backend API │ ├── src/ │ │ ├── main.rs │ │ ├── models.rs │ │ ├── svg_generator.rs │ │ └── persistent_counter.rs │ └── Cargo.toml ├── frontend_visit_counter/ # Yew WebAssembly frontend │ ├── src/ │ │ ├── main.rs │ │ ├── app.rs │ │ ├── components/ │ │ ├── services.rs │ │ └── types.rs │ ├── index.html │ └── Cargo.toml ├── static/assets/ # Shared CSS and assets │ ├── style.css │ ├── minimal-icons.css │ └── badges/ └── data/ # Persistent data storage 

• Backend: Rocket-based REST API with SVG generation and persistent storage
• Frontend: Yew WebAssembly application for badge management and admin interface
• Static Assets: Shared CSS, icons, and badges stored locally

(back to top)

Follow these instructions to set up a local instance of the Visit Counter API.

• Rust installed
• Cargo (bundled with Rust)
• Trunk (for frontend development): cargo install --locked trunk
• (Optional) Docker for containerized deployment

cd frontend_visit_counter trunk serve

This starts the frontend development server at http://localhost:8080

cd backend_visit_counter cargo run

This starts the API server at http://localhost:8000

Frontend:

cd frontend_visit_counter trunk build --release

Backend:

cd backend_visit_counter cargo build --release

(back to top)

Recommended: Use the development Docker Compose setup for testing:

docker-compose -f docker-compose.dev.yml up

This will start both the backend and frontend services in a development environment with hot reloading and proper networking.

You can also test the endpoints using curl or any HTTP client:

• GET Counter Value (JSON):

  curl http://localhost:8000/api/counter/test

• Increment Counter (JSON):

  curl -X POST http://localhost:8000/api/counter/test/increment

• SVG Counter Endpoint:

  curl "http://localhost:8000/counter/test/svg?label=Page%20Views&color=ff5733"

(back to top)

Create a docker-compose.yml file:

services: visit_counter: container_name: visit-counter image: git.prisma.moe/aichan/visit_counter:latest ports: - "8000:8000" environment: ROCKET_ADDRESS: "0.0.0.0" ROCKET_PORT: "8000" API_KEY: "your_secret_api_key_here" ADMIN_PASSWORD: "your_admin_password_here" volumes: - ./data:/data restart: unless-stopped

Then run:

docker-compose up -d

(back to top)

Contributions are welcome! Please fork the repository, make your changes, and open a pull request.

1. Fork the Project on Forgejo
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Distributed under the European Union Public License v1.2. See LICENSE for more information.

(back to top)

Aitor Astorga Saez de Vicuña - a.astorga.sdv@protonmail.com

Project Link: https://git.prisma.moe/aichan/visit_counter

(back to top)

This is based on Anton Komarev's github-profile-views-counter, but made in Rust with a cool WebAssembly frontend.

Thanks to these amazing projects and technologies!

• Rust Yew - A modern Rust framework for creating multi-threaded front-end web apps with WebAssembly
• Rocket - A web framework for Rust that makes it simple to write fast, secure web applications
• WebAssembly - A binary instruction format for a stack-based virtual machine
• Font Awesome - Icons used in the web interface (Free License)

This project uses Font Awesome icons, which are available under the Font Awesome Free License:

• Icons: CC BY 4.0 License (https://creativecommons.org/licenses/by/4.0/)
• Fonts: SIL OFL 1.1 License (https://scripts.sil.org/OFL)
• Code: MIT License (https://opensource.org/licenses/MIT)

The following Font Awesome icons are used in this project:

• fa-chart-line, fa-shield-alt, fa-sync-alt, fa-list, fa-plus, fa-eye, fa-calendar, fa-clock, fa-edit, fa-trash, fa-code, fa-check, fa-copy, fa-key, fa-home, fa-cog, fa-sign-in-alt, fa-sign-out-alt, fa-sun, fa-moon, fa-magic

(back to top)