This NestJs app allows you to create a fully interactive profile README, such as mine, by displaying functional minigames on the page.

It is inspired by some other dynamic profile READMEs (I remember timburgan's one as a motivation to start) that work with GitHub Actions on issues or by images, like the profile views counter service.

This project takes a different approach by creating a new commit on the repository for most of the provided features.

As you can see on many GitHub users' profiles, the profile is often divided into multiple sections such as "About Me", "My Projects", "My Tools", "Contact Me" etc.

This project follows the same philosophy by dividing the file into what are called modules, which handle the logic and rendering of each section of the final file.

The core files and folders of the app are as follows:

• src/modules: contains both static and dynamic modules. Each module encapsulates the logic for its section of the file and is also responsible for rendering that specific section.
• src/State.js: the State class manages all modules and the final rendering of the file.
• src/services/ConfigService.ts: a utility class used to access environment variables and the configuration object.
• src/services/ReadmeService.ts: a utility class used to interact with GitHub. Most of the time, you’ll want to call ReadmeService.updateReadmeAndRedirect(). (Use ReadmeService.doNothingAndRedirect() if there are no changes to apply.)
• src/services/RequestService.ts: a utility class used to interact with the GitHub REST and GraphQL APIs.

A module can extend either the AbstractStaticModule, which means it is not likely to change — for example, an “About Me” section.

A module can also extend the AbstractDynamicModule, which means it will change over time — for example, a chess game or a “Latest Followers” section.

The workflow in all modules/games follows the same pattern:

1. The user clicks a link in the README and makes a GET request to the app.
2. The involved controller is called.
3. The associated service is called.
4. If a commit is needed, the app waits for the commit to be performed.
5. The app returns a redirection to the client for the profile README page that has been updated.

This results in a seemingly simple page refresh for the user.

Requirements:

• Docker
• Node & NPM

Steps:

1. git clone https://github.com/Charles-Chrismann/dynamic-readme
2. dupe .env.example and rename it .env, fill variables
3. dupe config.example.json and rename it config.json, fill variables

npm run dev

npm run prod

docker compose -f docker-compose.dev.yml --env-file .env.dev down -v

redis-cli -h localhost -p 6379
KEYS *

docker exec dr-prod-redis redis-cli save
docker cp dr-prod-redis:/data/dump.rdb ./dump.rdb

docker cp ./dump.rdb dr-prod-redis:/data/dump.rdb
docker restart dr-prod-redis

docker compose -f docker-compose.dev.yml --env-file .env.dev down --volumes --remove-orphans
docker compose -f docker-compose.dev.yml --env-file .env.dev build --no-cache

Contributions are welcome!
If you want to improve the project, fix a bug, or add a new feature, feel free to open a pull request or submit an issue.

Before contributing, please make sure your code is clean, consistent, and well-documented.
Try to follow the existing project structure and naming conventions to keep everything coherent.

This project is licensed under the GNU General Public License v3.0 (GPL-3.0).

This means that:

• You are free to use, modify, and distribute the software.
• If you distribute a modified version, you must make your source code available under the same license (GPL-3.0).
• You cannot make the software proprietary or distribute it under a different license.
• Any derivative work must remain open source and credit the original author.

👉 In short: you can do almost anything with the code, as long as you keep it open source and share your modifications under the same terms.

For more details, see the full license text in the LICENSE file.

This section is not mean to be user friendly, just taking notes

{
  "reset": {
    "display": true,
    "content": "reset game"
  }
}