https://github.com/tokio-rs/website
Website for the Tokio project
https://github.com/tokio-rs/website
Last synced: about 1 month ago
JSON representation
Website for the Tokio project
- Host: GitHub
- URL: https://github.com/tokio-rs/website
- Owner: tokio-rs
- License: mit
- Created: 2016-11-16T18:46:52.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-02-25T12:01:13.000Z (4 months ago)
- Last Synced: 2025-04-29T08:21:32.148Z (about 2 months ago)
- Language: TypeScript
- Homepage: https://tokio.rs
- Size: 4.83 MB
- Stars: 244
- Watchers: 22
- Forks: 349
- Open Issues: 54
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tokio Website
The website for the Tokio project. Lives at https://tokio.rs.
Besides containing the content for the website, it also includes crates
containing the example code used in the tutorial. These crates can be compiled
and run.
* [hello-tokio](tutorial-code/hello-tokio/src/main.rs)
* [spawning](tutorial-code/spawning/src/main.rs)
* [shared-state](tutorial-code/shared-state/src/main.rs)
* [channels](tutorial-code/channels/src/main.rs)
* [io](tutorial-code/io)
* [echo-server-copy](tutorial-code/io/src/echo-server-copy.rs)
* [echo-server](tutorial-code/io/src/echo-server.rs)
* [mini-tokio](tutorial-code/mini-tokio/src/main.rs)
## Contributing
Thinking about contributing? Great! This should help you get the website running
locally.
### Getting Started
The website is built using [Next.js] paired with the [Bulma] CSS framework.
You'll need NPM to install the required packages with:
```bash
npm install
```
Next, start the development server:
```bash
npm run dev
```
Then, open [http://localhost:3000](http://localhost:3000).
[Next.js]: https://nextjs.org/
[Bulma]: https://bulma.io/
### Resources
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
- [Bulma documentation](https://bulma.io/documentation/) - learn about Bulma.
## License
This project is licensed under the [MIT license](LICENSE).
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in Tokio by you, shall be licensed as MIT, without any additional
terms or conditions.
You can run our tests by running the commands:
```
# in doc-test (unstable APIs are needed by some tests)
RUSTFLAGS="--cfg tokio_unstable" cargo +nightly test
# in tutorial-code
cargo test --all
```
The doc tests verify that all code blocks are valid Rust, and the tutorial-code folder
contains the full code examples from the tutorial.