forked from SystemCrafters/craftering
No description
- CSS 60.1%
- HTML 31.1%
- Nix 8.3%
- Shell 0.5%
| data | Switched to CSS grid based cards instead of html table for better responsive layout. | |
| .envrc | nix flake + build with nix | |
| .gitignore | nix flake + build with nix | |
| .woodpecker.yaml | enable build features | |
| config.json | Script to build ringfairy & generate webring, proposed woodpecker CI | |
| flake.lock | nix flake + build with nix | |
| flake.nix | nix flake + build with nix | |
| LICENSE | Added MIT license (c) 2024 David Wilson and the System Crafters Community | |
| readme.org | update readme with new build instructions | |
| serve.sh | nix flake + build with nix | |
| websites.json | Add site calebh.top | |
Craftering - A System Crafters Community Webring
Craftering is a webring powered by ringfairy for the personal websites/blogs for the System Crafters community.
Current state
- The project is just getting started with a few blogs and currently running off of craftering.shom.dev (a Caddy server on a VPS serving static content). Working on setting up CI/CD to run off Codeberg Pages.
- You can also add all feeds to your feed reader by importing the OPML file.
Instructions for joining via Pull Request
- Process overview: Sites are added to
websites.jsonand the output is generated based on the configuration options inconfig.json. The site is generated by runningringfairyin the folder with the configuration file. The ring is shuffled each time it is built so the relative position of each site will change over time and aide in more serendipity. - Please add the html links for the ring to your site BEFORE opening a PR so the deploy process can verify your site is working correctly and the ring isn't broken.
- Please add your site to the bottom of the
websites.jsonfile and maintain the correct indentation.Note: The last element in the list does not have a,at the end. So please add a comma before your section and make sure there isn't on at the end of your section. Submit a PR and we'll try to review and merge as soon as possible.
Instructions for joining via Issues
- If you have never made a PR before, this is a great opportunity to do so. We are happy to help you walk through the process. One of our goals is to get more people involved with contributing to projects, here and elsewhere. Please practice with here with us :)
- If you still prefer to join by creating a issue ticket, that's great too.
- Please add the html links for the ring to your site BEFORE opening an issue.
-
Please create a new issue with the following information:
- name(of your site): - slug (the @handle you'd like that you added in the links on your site): - about (a little blurb about yourself/your site): - url (the link to your site): - rss (the link to your rss/atom feed if you have one): - owner (your name, the way you want it to be displayed):
Future state
-
The future home of craftering will be on a SystemCrafters.net address.
- The future is now, site can be found at craftering.systemcrafters.net
- Please updates your site links but the old link from shom.dev are being redirected.
- The goal is to have people open PRs here to add their sites to the ring and generate the webring (build the static redirect pages) when the PR is merged via Codeberg's CI and deploy to Codeberg Pages.
- Maintenance builds schedules can also be setup to verify the sites are operational and displaying the craftering links to ensure the ring is not broken.
- There are many possibilities of how the community uses the ring data websites.json (canonical raw data location, this won't change you can build with it). Like integrating openring style article previews on your own site from recent articles from craftering's RSS feeds.
Development
Building
Craftering is a nix flake.
Build it with:
nix build .#
This will produce the website in ./result/www.
Serving the site
For local development, you can run the site with:
./serve.sh
and then open your browser to http://localhost:8080