An open source recipe book from the awesome staff of Clinical Genomics. Link to the available recipes: https://clinical-genomics.github.io/meatballs/
This repository is created as GitHub playground for the group workshop in Sigtuna (28-29 Oct 2021).
We hope that it will be a fun way to learn how to use GitHub for opening and reviewing pull requests!
Requires git software installed (https://github.com/git-guides/install-git). If you have Docker installed on your computer you could run meatballs locally using the following commands
Howto:
- Clone this repository to your computer with the following command:
git clone https://github.com/Clinical-Genomics/meatballs.git
- Move your working directory in the cloned repository folder:
cd meatballs
- Build and run the Docker image:
docker build -t meatballs .
- Run the image:
docker run --rm -p 8080:8080 meatballs
You could now browse the content of meatballs using the url: http://0.0.0.0:8080/ in a browser of your choice.
Looking to submit a recipe? Follow these instructions:
The content of your recipe should be included in the docs folder of this repository. Make sure your recipe is created in the right category (appetizers, main_courses, desserts, drinks ..?). The text should be formatted in markdown.
To create a pull request you could either:
- Create a new branch containing the changes on your computer and then push it to this repository to open the pull request
- Use the GitHub web-based editor to add changes and open a pull request
A simple guide on how to open a general pull request in GitHub can be found here. Keep in mind that this is the usual way to work with pull requests, but it requires basic usage of the terminal.
A guide on how to create a pull request using the GitHub web editor is present here
This option is only available if you have the repository installed locally. You could preview the content of the docs folder by running:
mkdocs serve