alexsmbaratti / pixel-shelf Goto Github PK

Allow users to download a file that can be uploaded to another Pixel Shelf instance to restore the state of the original instance

The current schema for API responses follows the following general pattern:

{
    "status": 200,
    "data": {}
}

The status code is fairly redundant and never used. I am open to suggestions to what may be more effective schema. That may be as simple as just returning the data, but I would like it to look somewhat sophisticated if possible. In addition, I am open to suggestions for error schemas.

If you have suggestions, please reply with a comment below with your suggestions.

Is your feature request related to a problem? Please describe.
All pages and API endpoints are currently exposed with no authentication requirement.

Describe the solution you'd like
Some form of login that protects endpoints and pages. Either custom login or use Discord or Twitch authentication.

Describe alternatives you've considered
N/A

Additional context
N/A

Is your feature request related to a problem? Please describe.
Currently, the config.json file must be used to enter Apple Maps API information. Information includes key ID, team ID, and key path at minimum.

Describe the solution you'd like
Allow the entering of this information via a setup prompt or using the backend page.

Describe alternatives you've considered
N/A

Additional context
N/A

Because only dates were needed, it was initially decided to use three integer fields for storing dates in the SQLite database: month, day, and year. However, this is causing more issues than solutions. Note that time and timezones are not relevant to Pixel Shelf. Switching to Unix time will make it simple to tell if a date is invalid or unknown, easy to plot library size over time, and fix date rendering issues.

Appears to be a race condition when multiple requests are made to the SQLiteDriver at the same time

This can be used to make the chart change less radically with asynchronous network calls

Is your feature request related to a problem? Please describe.
Currently, the config.json file must be used to enter IGDB API information. Information includes client ID and client secret at minimum.

Describe the solution you'd like
Allow the entering of this information via a setup prompt or using the backend page.

Describe alternatives you've considered
N/A

Additional context
N/A

Is your feature request related to a problem? Please describe.
Game title, platform, date added, and retailers cannot yet be edited yet in the menu.

Describe the solution you'd like
Allow for editing of all fields.

Describe alternatives you've considered
N/A

Additional context
N/A

Characters, specifically single quote characters, cause SQL issues. This leads to a variety of problems, including causing the library count by platform to be inaccurate. This is believed to occur because a library entry will be added, but not game or edition entries to complement it. This causes the count by platform endpoint to miss these entries.

Upon further deliberation, progress would be best in the library table. While this means any potential duplicate copies may not be synced, it also means that game entries can be aggregated and shared, and that deleting an in progress library entry will not cause that game to continue to appear on the index screen. It also allows a user to easily hyperlink to the library entry in question.

Create detailed documentation of API endpoints, including params, body, and response information