Loggee - A tool to interact with your board game collection and plays (made in Elixir)
a project by gfilippetti
Updated over 3 years ago. 3 hacker ♥️. 2 followers.

Project Description

I started developing Loggee as a CLI to interact with Board Game Geek and it's API. I wanted to have an easy way to see my games and log my plays in the site, and as a bonus, learn more of the functional programming language Elixir.

I'm really happy with the results so far, but now I want to improve the tool in several ways:

Goal for this Hackweek

Implement a telegram bot:

I want to implement an interactive telegram bot, so I can post my plays and see my games directly via telegram. I already have a draft of some commands in a branch, using this project as base, but I still need to learn how to make it more interactive.

Implement a web UI

The API part will be made with the Phoenix framework, and I'm deciding if the UI will be made with it or with React.

General CLI UI improvements

The CLI is not so nice to use, and spits Elixir structures instead of human readable information. I want to change that.

I won't be able to work in all those fronts, so I'll decide at the time which one of them I want to tackle. If you want to join, or give your feedback on what features you think would be useful for you, feel free to do so!

Resources

Loggee

Board Game Geek (BGG)

BGG API

Elixir lang docs

Phoenix framework

Progress log

  • In days 1 and 2, I managed to create, configure and deploy the telegram bot (@loggee_bot, currently offline). It was deployed to gigalixir.com, a heroku-like service made specially for hosting elixir projects. The bot currently has all the features from the CLI, except posting a new play to boardgamegeek.com

  • Day 3: initialized the Phoenix app, with the CLI/telegram bot as a dependency. Created the users table to save the bgg username and password (encrypted) and telegram username (will be used to interact with the bot)

Hackweek 21

  • Fix a few bugs, refactor functions and improve overall usability, especially on the Stats option

Join this project

Looking for hackers with the skills:

elixir-lang boardgames cli phoenix

This project is part of:

Hack Week 20 Hack Week 21

Activity

  • over 4 years ago: lcaparroz liked this project.
  • over 4 years ago: ancorgs liked this project.
  • over 4 years ago: gfilippetti liked this project.
  • over 4 years ago: gfilippetti started this project.
  • over 4 years ago: gfilippetti added keyword "elixir-lang" to this project.
  • over 4 years ago: gfilippetti added keyword "boardgames" to this project.
  • over 4 years ago: gfilippetti added keyword "cli" to this project.
  • over 4 years ago: gfilippetti added keyword "phoenix" to this project.
  • over 4 years ago: gfilippetti originated this project.


    • Comments

    Be the first to comment!

    Similar Projects

    A CLI for Harvester by mohamed.belgaied

    [comment]: # Harvester does not officially come with a CLI tool, the user is supposed to interact with Harvester mostly through the UI [comment]: # Though it is theoretically possible to use kubectl to interact with Harvester, the manipulation of Kubevirt YAML objects is absolutely not user friendly. [comment]: # Inspired by tools like multipass from Canonical to easily and rapidly create one of multiple VMs, I began the development of Harvester CLI. Currently, it works but Harvester CLI needs some love to be up-to-date with Harvester v1.0.2 and needs some bug fixes and improvements as well.

    Project Description

    Harvester CLI is a command line interface tool written in Go, designed to simplify interfacing with a Harvester cluster as a user. It is especially useful for testing purposes as you can easily and rapidly create VMs in Harvester by providing a simple command such as: harvester vm create my-vm --count 5 to create 5 VMs named my-vm-01 to my-vm-05.

    asciicast

    Harvester CLI is functional but needs a number of improvements: up-to-date functionality with Harvester v1.0.2 (some minor issues right now), modifying the default behaviour to create an opensuse VM instead of an ubuntu VM, solve some bugs, etc.

    Github Repo for Harvester CLI: https://github.com/belgaied2/harvester-cli

    Done in previous Hackweeks

    • Create a Github actions pipeline to automatically integrate Harvester CLI to Homebrew repositories: DONE
    • Automatically package Harvester CLI for OpenSUSE / Redhat RPMs or DEBs: DONE

    Goal for this Hackweek

    The goal for this Hackweek is to bring Harvester CLI up-to-speed with latest Harvester versions (v1.3.X and v1.4.X), and improve the code quality as well as implement some simple features and bug fixes.

    Some nice additions might be: * Improve handling of namespaced objects * Add features, such as network management or Load Balancer creation ? * Add more unit tests and, why not, e2e tests * Improve CI * Improve the overall code quality * Test the program and create issues for it

    Issue list is here: https://github.com/belgaied2/harvester-cli/issues

    Resources

    The project is written in Go, and using client-go the Kubernetes Go Client libraries to communicate with the Harvester API (which is Kubernetes in fact). Welcome contributions are:

    • Testing it and creating issues
    • Documentation
    • Go code improvement

    What you might learn

    Harvester CLI might be interesting to you if you want to learn more about:

    • GitHub Actions
    • Harvester as a SUSE Product
    • Go programming language
    • Kubernetes API