clear

download

> product page

feedback

if there are any features or bug fixes you'd like to suggest, please open a new issue

getting started

dev requirements for the project

app/website	nodejs	pnpm	rust
api	uv

when that is done you can run the code in development mode, by doing the following:

• git clone https://github.com/adithyasource/clear
• cd clear
• pnpm install
• pnpm run tauri dev

to build the app, you can run pnpm run tauri build

website

• cd website
• pnpm install
• pnpm run dev or pnpm run build (to compile tailwind)

api

• cd api
• uv sync
• uv run api/app.py

contributing

thank you so much for considering contributing to clear! i really appreciate it ^-^
expand the following sections to know more!

translations

you would need to look at the file Text.js. here you can find the translations for each language. some languages were originally generated using google translate in order to get the ball rolling.

language	status
french	✅ completed (by @jer3m01)
russian	✅ completed (by @vladbrox)
japanese	google translate
spanish	google translate
hindi	✅ completed (by me, please feel free to improve)

to update the file with more accurate translations you'll have to fork the repository and create a new branch with your changes after which you can create a pull request.

you can add a new language by adding a new simple 2-3 letter key to the JSON for every language.

for example, to add a new language, say hebrew (shortened to he), change all text snippets like this

"import Steam games": {
  jp: "Steam ゲームをインポートする",
  .
  .
  .
  he: "Your translation goes here"
},

if you would like to contribute to the translations but do not know how to do so by modifying JSON or using Git/GitHub, you can create a new issue with all the improved/new translations for all the text.

code

a bunch of ideas and features that i'm working on / will work on are mentioned in this github projects kanban board. if you find something that interests you, it'd be great if you could implement it! if you need any assistance, you can always open up a new issue

please make sure that you do not implement any major new features that are not on the kanban board before opening an issue discussing it. this is in order to make that that the clear's original purpose of being clean, minimalistic and simple to use stays true.

you'll have to fork the repository and create a new branch with your changes after which you can create a pull request.

if you find any bugs, you can always open a new issue or fix the bug yourself!

formatting and linting

required editor tools

app/website	biome
api	ruff	ty

make sure to format and lint the code before committing, either by using your editor's features or by running pnpm lint and pnpm format for app code or ruff check and ruff format for api code

api

the following routes are available

• get a game's SGDB ID using the game's Steam ID

  /?steamID=70
  

• get a game's SGDB ID using the game's name

  /?gameName=cyberpunk%202077
  

• get links to a game's grids, heroes, logos and icons using the game's SGDB ID

  /?assets=24116
  

• get a binary integer list for one grid, hero, logo and icon of a game using the game's SGDB ID

  /?limitedAssets=24116
  

• get a binary integer list for the any given image link

  /?image=https://cdn2.steamgriddb.com/thumb/12f59e05c632bd17f2409172507d6407.png
  

• get the current version of 'clear'

  /?version=put_any_string_here_since_it_doesnt_get_read
  

acknowledgments

tech	tauri	solidjs	tailwind

design	basicons

code snippets	fuzzy search	valve vdf parser

for api	flask	steamgriddb