Retro leaderboards is a small easy to use Retroachievements.org companion website (mobile first design) that allows you to compare your recently played games leaderboards with your friends. You only need two things in order to use it: your username and your web api key (which can be gathered from your setting page, under the Keys section)
This small webpage is built using VITE and VUE. Uses GitHub Pages to host. It uses local storage to keep track of visited games information (so we don't overwhelm the server each time we navigate through pages). Sensitive data is stored using crypto-js. Testing aiming for full code coverage with Cypress.
It tries to. Always keeping in mind that is a frontend application running in your browser which are never exempt of risks.
- So how does it try to be safe?
- Basically it encrypts sensitive data before storing it to local storage.
- Why does it store the data in first place?
- So you don't have to fill it up every time you want to use the app.
- What if I don't want to keep my secrets stored?
- Then you could log out after each use and all your stored data will be deleted.
Create a .env file in your project's root folder.
VITE_API_URL=https://retroachievements.org
VITE_ENCRYPTION_KEY=example
Install node, at least version 18. First run npm install
and then npm run dev
.
The project should be accessible via http://localhost:5173/.