https://github.com/rust-lang/areweasyncyet.rs

Are we async yet?
https://github.com/rust-lang/areweasyncyet.rs

rust

Last synced: about 1 month ago
JSON representation

Are we async yet?

• Host: GitHub
• URL: https://github.com/rust-lang/areweasyncyet.rs
• Owner: rust-lang
• License: apache-2.0
• Created: 2018-12-29T05:20:16.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-05-11T09:35:38.000Z (over 1 year ago)
• Last Synced: 2024-09-29T21:03:47.418Z (about 2 months ago)
• Topics: rust
• Language: Rust
• Homepage: https://areweasyncyet.rs
• Size: 676 KB
• Stars: 211
• Watchers: 30
• Forks: 30
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# Are we async yet

[![Build Status](https://travis-ci.org/rust-lang/areweasyncyet.rs.svg?branch=master)](https://travis-ci.org/rust-lang/areweasyncyet.rs)

areweasyncyet.rs is a website for tracking development progress of

`async`/`await` syntax of Rust programming language in

the language itself as well as its ecosystem.

It's implemented as a static page generator,

and deployed to GitHub Pages via Travis.

## Building

To build the site locally,

you would need a GitHub personal access token for

fetching data from GitHub.

You can refer to [this article](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) for how to create such token.

Once you get the token,

put it into `.env` file like this:

```

GITHUB_TOKEN={your token}

```

and then execute `cargo run`.

You may also want to enable logs by adding

```

RUST_LOG=areweasyncyet=debug

```

to the `.env` file.

From there,

the generated HTML will be in the `_site` directory.

You can use any web server to check it out in your browser:

```

cd _site

python3 -m http.server

```

## Development

The Rust code handles issue data from GitHub.

Content mainly resides in `data.yml` and `templates` directory.

After the first execution,

fetched data will be stored in `cache.json` file in the current directory

to avoid repeatedly fetching data when updating `data.yml` and `templates`.

If the latest data from GitHub is needed,

simply remove the `cache.json` file.