Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/aiogram/site

Landing and Blog site

https://github.com/aiogram/site

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.8%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

Landing and Blog site

Basic Info
  • Host: GitHub
  • Owner: aiogram
  • Language: HTML
  • Default Branch: main
  • Size: 192 KB
Statistics
  • Stars: 2
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme

README.md

aiogram Website

This repository contains the source code for the aiogram framework's official website.

About aiogram

aiogram is a modern and fully asynchronous framework for Telegram Bot API written in Python using asyncio and aiohttp. It's designed to be easy to use and focuses on modern Python features.

Important Links

External Resources

The aiogram website integrates with several external resources:

  • The Documentation is hosted separately at docs.aiogram.dev
  • The Blog content is provided via the Telegram channel @aiogram_live rather than being part of the Jekyll site
  • The site also links to the GitHub repository and other community resources

Development

This website is built using Jekyll, a static site generator.

Running with Docker

The easiest way to run this site locally is using Docker:

  1. Clone this repository: git clone https://github.com/aiogram/site.git cd site

  2. Build and run using Docker Compose: docker-compose up

  3. Visit http://localhost:4000 in your browser to see the site.

Running without Docker

If you prefer to run the site without Docker:

  1. Install Ruby and Bundler
  2. Clone this repository
  3. Install dependencies: bundle install
  4. Run the development server: bundle exec jekyll serve --livereload
  5. Visit http://localhost:4000 in your browser

Alternative with Rake

You can also use Rake tasks for common operations:

```bash

Serve locally

rake serve

Build for production

rake build

Serve with production environment

rake serve_prod

Clean build artifacts

rake clean ```

GitHub Pages Deployment

This site is configured to deploy automatically to GitHub Pages using GitHub Actions. Here's how it works:

  1. When you push to the main branch, GitHub Actions will build and deploy the site
  2. The workflow is defined in .github/workflows/github-pages.yml
  3. The site is deployed to aiogram.dev

Manual Deployment

If you need to deploy manually:

  1. Build the site: JEKYLL_ENV=production bundle exec jekyll build

  2. The built site will be in the _site directory

Troubleshooting

Missing theme error

If you get an error like The minima theme could not be found, make sure you have the minima gem installed in your Gemfile:

ruby gem "minima", "~> 2.5.1"

Then run bundle install before starting the server.

Contributing

Contributions to improve the website are welcome! Please follow these steps:

  1. Fork the repository
  2. Create your feature branch
  3. Make your changes
  4. Submit a pull request

License

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

Owner

  • Name: aiogram
  • Login: aiogram
  • Kind: organization
  • Email: github@aiogram.dev

GitHub Events

Total
  • Watch event: 2
  • Delete event: 1
  • Push event: 9
  • Create event: 3
Last Year
  • Watch event: 2
  • Delete event: 1
  • Push event: 9
  • Create event: 3

Committers

Last synced: 12 months ago

All Time
  • Total Commits: 14
  • Total Committers: 1
  • Avg Commits per committer: 14.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 14
  • Committers: 1
  • Avg Commits per committer: 14.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
JRoot Junior j****r@g****m 14

Issues and Pull Requests

Last synced: 12 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/jekyll.yml actions
  • actions/checkout v4 composite
  • actions/configure-pages v5 composite
  • actions/deploy-pages v4 composite
  • actions/upload-pages-artifact v3 composite
  • ruby/setup-ruby 4a9ddd6f338a97768b8006bf671dfbad383215f4 composite
Dockerfile docker
  • jekyll/jekyll 4.2.2 build
docker-compose.yml docker
Gemfile rubygems
  • jekyll-feed ~> 0.16.0 development
  • jekyll-paginate ~> 1.1.0 development
  • jekyll-seo-tag ~> 2.8.0 development
  • jekyll-sitemap ~> 1.4.0 development
  • jekyll ~> 4.2.2
  • minima ~> 2.5.1
  • rake ~> 13.0
  • webrick ~> 1.7