Mirror of https://github.com/roostorg/playground
github.com/roostorg/playground
README: move local dev info here, make it generic
+15
-16
-15
CONTRIBUTING.md
-15
CONTRIBUTING.md
···
1
-
# Contributing
2
-
3
-
Contributions welcome! Please open a PR for simple/straightforward changes, or open an issue to discuss things before writing code.
4
-
5
-
## Building
6
-
7
-
I recommend using `toolbox` for local development, especially if you're on Endless OS or Fedora Silverblue. See [this blog post](https://cassidyjames.com/blog/github-pages-jekyll-fedora-silverblue/) for details on how to get set up.
8
-
9
-
Once you're set up, build and serve locally with:
10
-
11
-
```shell
12
-
bundle exec jekyll serve --host 0.0.0.0
13
-
```
14
-
15
-
The site should now be available at http://0.0.0.0:4000/ on your local machine, and your local machine's IP address on your network—great for testing on mobile OSes.
+15
-1
README.md
+15
-1
README.md
···
14
14
15
15
## Adding a project
16
16
17
-
Projects live in `_data/projects.yml`. Open a pull request to add your own project, ensuring you include:
17
+
Projects live in [`_data/projects.yml`](_data/projects.yml). Open a pull request to add your own project, ensuring you include:
18
18
19
19
1. Title
20
20
2. Description
···
22
22
4. Tags (see existing projects for reference)
23
23
24
24
Someone from @roostorg/roosters will review and merge your pull request if approved!
25
+
26
+
## Local development
27
+
28
+
If you want to hack on this project locally, it's a fairly simple static site built with [Jekyll](https://jekyllrb.com/) and served by [GitHub Pages](https://docs.github.com/en/pages).
29
+
30
+
1. **Prerequisites**: you'll need to install [Ruby](https://www.ruby-lang.org/en/documentation/installation/), [Bundler](https://bundler.io/), and [Jekyll](https://jekyllrb.com/docs/installation/).
31
+
32
+
2. **Project dependencies** are managed as Ruby gems with Bundler. Run `bundle install` to get everything set up the first time.
33
+
34
+
3. **Build and serve** the site locally with Jekyll using `bundle exec jekyll serve`, then navigate to [http://localhost:4000](http://localhost:4000).
35
+
36
+
To make it accessible on your local network (e.g. to test from a mobile device), append `--host 0.0.0.0`, then navigate to `http://your-local-ip-address:4000` from the other device.
37
+
38
+
See the [GitHub docs](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll) for more information.