LowLevelAcademy Save

This is the main repository for the website, including the front-end code and all content.

Project README

Low-Level Academy

This repository hosts front-end code for Low-Level Academy, an interactive systems programming course.

Related repositories:

Project structure

The project structure follows the Next.js conventions.

  • pages - this directory contains all static pages.
  • public - static content.
  • components - all React components used in the lessons.
  • playground - code that is based on the Rust playground UI.

Building the website

Before building the website, you might need to setup the environment variables.

Create a file named .env.local and add the following contents:

GITHUB_TOKEN=<your GitHub personal access token>

This token is required for accessing the GitHub GraphQL API. You can create a new token in "Settings".

Run in the development mode:

npm run dev

Build for production:

npm run build

Dependencies

This website depends on WebAssembly modules.

You can find them in the wasm-modules repository, and you will need to build the virtualnet module using the following command:

cargo build --release --target wasm32-unknown-unknown

Then, you will need to place the resulting target/wasm32-unknown-unknown/release/virtualnet.wasm file into the public/ directory to make it work.

Code style

We use the default Prettier code format.

License

Code in this repository is licensed under either of

at your option.

The courses text is licensed under Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International.

You are free to:

  • Share — copy and redistribute the material in any medium or format.
  • Adapt — remix, transform, and build upon the material.

Under the following terms:

  • Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.

  • NonCommercial — You may not use the material for commercial purposes.

  • ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.

  • No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.

Open Source Agenda is not affiliated with "LowLevelAcademy" Project. README Source: LowLevelAcademy/LowLevelAcademy
Stars
193
Open Issues
3
Last Commit
1 year ago
License

Open Source Agenda Badge

Open Source Agenda Rating