Showcasing Github repositories??

#github #showdev #beginners

I'm in the process of building my own website right now. I want to showcase some repos I have on github. What would I need to showcase?

Top comments (7)

Vincent A. Cicirello • Sep 16 '22

There are lots of ways of doing it. So I'm not claiming that my examples below are the only way. What makes sense for my project might not for yours. In fact, you'll notice that my second example is rather different than the first, at least in terms of content, even if color theme is same. But here are a couple ways that I have done it.

In this first example, I have a site focused on one library. Homepage is about the library. It is a Java project so I also have the javadocs there. I then have links to the GitHub repository as well as to a separate repository with example usage, and a couple other more specific links such as straight to the changelog, etc.

Chips-n-Salsa - A Java library of customizable, hybridizable, iterative, parallel, stochastic, and self-adaptive local search algorithms

The Chips-n-Salsa library includes implementations of several stochastic local search algorithms, including simulated annealing, hill climbers, as well as constructive search algorithms such as stochastic sampling; and now also includes genetic algorithms as well as evolutionary algorithms more generally. It includes several classes for representing solutions to a variety of optimization problems. For example, the library includes a BitVector class that implements vectors of bits, as well as classes for representing solutions to problems where we are searching for an optimal vector of integers or reals. For each of the built-in representations, the library provides the most common mutation operators and crossover operators for use with evolutionary algorithms. The library provides extensive support for permutation optimization problems, including implementations of many different mutation operators for permutations, and utilizing the efficiently implemented Permutation class of the JavaPermutationTools (JPT) library. Chips-n-Salsa is customizable, making extensive use of generic types, enabling using the library to optimize other types of representations beyond what is provided in the library. It is hybridizable, providing support for integrating multiple forms of local search (e.g., using a hill climber on a solution generated by simulated annealing), creating hybrid mutation operators (e.g., local search using multiple mutation operators), and classes that support running more than one type of search for the same problem concurrently using multiple threads as a form of algorithm portfolio. Chips-n-Salsa is iterative, with support for multistart metaheuristics, including implementations of several restart schedules for varying the run lengths across the restarts. It also supports parallel execution of multiple instances of the same, or different, stochastic local search algorithms for an instance of a problem to accelerate the search process. The library supports self-adaptive search in a variety of ways, such as including implementations of adaptive annealing schedules for simulated annealing, such as the Modified Lam schedule, implementations of the simpler annealing schedules but which self-tune the initial temperature and other parameters, and restart schedules that adapt to run length.

chips-n-salsa.cicirello.org

In this second example, I have a site about several GitHub Actions that I've developed. Homepage is a general summary of all of them. It then links to individual pages about each tool. The page for each tool then summarizes purpose and has relevant links such as to the GitHub repository, and in some cases has links to relevant files in other projects that use the tool.

Vincent Cicirello - Open source GitHub Actions for workflow automation

Features information on several open source GitHub Actions for workflow automation that we have developed to automate parts of the CI/CD pipeline, and other repetitive tasks. The GitHub Actions featured include jacoco-badge-generator, generate-sitemap, user-statistician, and javadoc-cleanup.

actions.cicirello.org

Lithi • Sep 16 '22

Thank you for all the help. The first example is something closer to what I was envisioning. Thank you🙏🏾

Vincent A. Cicirello • Sep 16 '22 • Edited

You're welcome. I have noticed that having a website about a project does help bring visitors to the GitHub repository, as seen in the traffic data on the insights tab of the repository where it shows the referrers to the repository.