https://github.com/sagikazarmark/workshop-template
Workshop repository template
https://github.com/sagikazarmark/workshop-template
template template-repository workshop
Last synced: 6 months ago
JSON representation
Workshop repository template
- Host: GitHub
- URL: https://github.com/sagikazarmark/workshop-template
- Owner: sagikazarmark
- Created: 2021-10-08T16:04:15.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-07-11T05:24:18.000Z (over 2 years ago)
- Last Synced: 2025-04-02T13:50:10.925Z (6 months ago)
- Topics: template, template-repository, workshop
- Language: Nix
- Homepage: https://sagikazarmark.github.io/workshop-template/
- Size: 1.96 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Workshop Template
This repository is a template for creating workshop material and slides for coding topics.
It comes with a basic structure (README, Makefile) for tooling and a [RevealJS](https://revealjs.com/) slide deck example.
The slides are published to [GitHub Pages](https://pages.github.com/) using [Quarto](https://quarto.org/).
Here is a workshop based on this example: https://github.com/sagikazarmark/temporal-intro-workshop/
## Usage
1. Create a new repo based on this template
1. Clone the repository
1. Install dependencies
- **Option 1 (recommended):** Make sure [nix](https://nixos.org) and [direnv](https://direnv.net) are installed, then run `direnv allow`
- **Option 2:** Install [Quarto](https://quarto.org/docs/get-started/) manually
1. Make changes to [slides/index.qmd](slides/index.qmd)
1. Run `make slides` to open the slides in your browser
1. Add your workshop material to the repo (eg. code examples to [examples](examples), solutions to [solutions](solutions))
1. Add some tests to [.github/workflows/ci.yaml](.github/workflows/ci.yaml)
1. Fill out the README template below
1. Push changes
1. Enable GitHub Pages in your repository settings
-----DELETE THIS LINE AND ABOVE-----
# [YOUR WORKSHOP TITLE]
## Prerequisites
> Add your prerequisites here
> For example: Make sure [nix](https://nixos.org) and [direnv](https://direnv.net) are installed, then run `direnv allow`
## Usage
> Adjust the instructions below
1. Checkout this repository
1. Run `make up`
1. ...
## [HOW TO USE THIS REPO]
> Add your instructions here
## Cleaning up
Once you are finished with the workshop, you can clean up all resources by running the following command:
```bash
make down
```
## Development
> Add your instructions for working on the workshop material.
Make sure [nix](https://nixos.org) and [direnv](https://direnv.net) are installed, then run `direnv allow`.
To work on the slides, run `make slides`.
It will open a browser window and automatically refresh the page when you make changes to the slides.