jacoby6000 / clone-hero-chart-db Goto Github PK

A structure like below should represent the data perfectly:

case class IniKey(k: String)
sealed trait IniValue
case class IniString(s: String) extends IniValue
case class IniSection(k: String)

type IniFile = Map[Option[IniSection], Map[IniKey, IniValue]]

With some methods for helping pull things out of the ini data.

IniValue sealed trait is just in case we need support for more than just strings.

Add ability to read chart files and do arbitrary analysis.

This shouldn't be used in production, so I'm not making it a part of the 1.0.0 milestone.

There's currently an interface allowing for it, but the indexer only supports a single filesystem at a time right now.

This'll get easier as more stuff gets added. Right now it's just a hodgepodge.

Specifically, unique key constraint failures need to be handled better. There are likely others, but not sure which ones should be explicitly dealt with.

https://gist.github.com/alexknvl/f429f76d6098d4b5fee423f0f14d5a7d

Should include everything necessary to get the system up and running locally.

Look at sections of the chart and determine what patterns it uses often. Things like trill, rolling hopos, two-handed taps, etc;

The public API should be simple get routes that don't provide searching in any fashion. Things like:

/api/v1/charts/<id>
/api/v1/artists/<id>/songs/by-name/<name>
/api/v1/artists/by-name/<name>/songs/by-name/<name>

The private api will support proper querying, like you'd expect:

/api/v1/songs?query=name;like;*foo*
/api/v1/songs?query=genre;eq;Progressive Djent Metal

queries will be composable so that users may specify additional conditions.

Responses will look something like:

{
  "songs": [
    {
      "id": "some-uuid-thing-here",
      "name": "song-name",
      "artist": "song-artist",
      "genre": "song-genre",
      "charter": "charter",
      "lastUpdated": "Some ISO date",
      "firstSeen": "Some ISO date"
    },
   ...
   ]
}

genre, charter, and artist are optional fields, and will not be present if they could not be determined.

Another route will be provided, such that ini file data can be fetched when given a song id.