rypi-dev/rypi-scrapper
1
0
Fork 0
Code Issues Pull Requests Actions Releases Activity
feat/game(data/assets)-downloader
rypi-scrapper/README.md

95 lines
4.0 KiB
Markdown
Raw Permalink Normal View History

feat(all-in-one): update prettier config, enable format on save Update the VSCode settings.json to include the Prettier VSCode formatter, and enable formatting on save. A new LICENSE file is added to comply with the MIT license due to the open-source nature of the project. The README.md file has now core features and to-dos that should be taken care of as the project continues to evolve. The index.html file is modified to match changes in src/index.tsx. The postcss configuration files are created, and some files are updated. Finally, new files like build.rs, draworder.json, and commands.rs were created
2023-05-02 16:51:22 +02:00
# 🧿 Getting started
## 🎯 Todos
- [ ] Two options for downloading Habbo resources:
- [ ] Default data extraction. (Without conversion)
- [ ] Using [Scuti](https://scuti.netlify.app/) dataset for its [renderer.](https://github.com/kozennnn/scuti-renderer)
refactor(markdown): update README
2023-05-04 17:14:30 +02:00
- [x] Languages feature. (Default: EN)
feat(all-in-one): update prettier config, enable format on save Update the VSCode settings.json to include the Prettier VSCode formatter, and enable formatting on save. A new LICENSE file is added to comply with the MIT license due to the open-source nature of the project. The README.md file has now core features and to-dos that should be taken care of as the project continues to evolve. The index.html file is modified to match changes in src/index.tsx. The postcss configuration files are created, and some files are updated. Finally, new files like build.rs, draworder.json, and commands.rs were created
2023-05-02 16:51:22 +02:00
- [ ] Download Habbo assets. (>800 MB of disk memory, make sure the IPC handles it correctly)
fix(styles): animation issues
2023-05-02 18:02:31 +02:00
- [x] Fix rendering animation issues.
refactor(markdown): update README
2023-05-04 17:14:30 +02:00
- [ ] Add "abort" button with data suppression feature.
feat(all-in-one): update prettier config, enable format on save Update the VSCode settings.json to include the Prettier VSCode formatter, and enable formatting on save. A new LICENSE file is added to comply with the MIT license due to the open-source nature of the project. The README.md file has now core features and to-dos that should be taken care of as the project continues to evolve. The index.html file is modified to match changes in src/index.tsx. The postcss configuration files are created, and some files are updated. Finally, new files like build.rs, draworder.json, and commands.rs were created
2023-05-02 16:51:22 +02:00
- [x] Convert front-end with SolidJS
- [x] Fix issue of prettier-plugin-tailwindcss
refactor(markdown): update README
2023-05-04 17:14:30 +02:00
- [ ] Export helpers/utils methods into Rust:
feat(all-in-one): update prettier config, enable format on save Update the VSCode settings.json to include the Prettier VSCode formatter, and enable formatting on save. A new LICENSE file is added to comply with the MIT license due to the open-source nature of the project. The README.md file has now core features and to-dos that should be taken care of as the project continues to evolve. The index.html file is modified to match changes in src/index.tsx. The postcss configuration files are created, and some files are updated. Finally, new files like build.rs, draworder.json, and commands.rs were created
2023-05-02 16:51:22 +02:00
- [ ] Implementing typesafety with types' collections using Tauri Specta
- [ ] Handling extracted data in:
- [ ] JSON (Default + Adjustements for Scuti)
- [ ] XML (Using quickxml_to_serde)
- [ ] TXT (no idea...)
- [ ] Parsing data using `std::{fs::File, io::Write}`
refactor(markdown): update README
2023-05-04 17:14:30 +02:00
- [ ] Learning Rust:
- [ ] Getting to know about vectors in depth.
feat(all-in-one): update prettier config, enable format on save Update the VSCode settings.json to include the Prettier VSCode formatter, and enable formatting on save. A new LICENSE file is added to comply with the MIT license due to the open-source nature of the project. The README.md file has now core features and to-dos that should be taken care of as the project continues to evolve. The index.html file is modified to match changes in src/index.tsx. The postcss configuration files are created, and some files are updated. Finally, new files like build.rs, draworder.json, and commands.rs were created
2023-05-02 16:51:22 +02:00
- [ ] Avoid conflicts in open-source.
- [ ] Undertsand: Memory cache and disk cache.
## Overview
- [How it works](#🏗️-how-it-works)
- [Techs stack](#📦-techs-stack)
- [Interesting topics](#📤-interesting-topics)
- [Credits](#🤝-credits)
## 📦 Techs stack
![Rust lang](https://img.shields.io/badge/Rust-black?style=for-the-badge&logo=rust&logoColor=#E57324)
![Typescript lang](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
refactor(markdown): update README
2023-05-04 17:14:30 +02:00
![Tauri](https://img.shields.io/badge/tauri-%2324C8DB.svg?style=for-the-badge&logo=tauri&logoColor=%23FFFFFF)
feat(all-in-one): update prettier config, enable format on save Update the VSCode settings.json to include the Prettier VSCode formatter, and enable formatting on save. A new LICENSE file is added to comply with the MIT license due to the open-source nature of the project. The README.md file has now core features and to-dos that should be taken care of as the project continues to evolve. The index.html file is modified to match changes in src/index.tsx. The postcss configuration files are created, and some files are updated. Finally, new files like build.rs, draworder.json, and commands.rs were created
2023-05-02 16:51:22 +02:00
![Vite](https://img.shields.io/badge/Vite-B73BFE?style=for-the-badge&logo=vite&logoColor=FFD62E)
refactor(markdown): update README
2023-05-04 17:14:30 +02:00
![SolidJS](https://img.shields.io/badge/SolidJS-2c4f7c?style=for-the-badge&logo=solid&logoColor=c8c9cb)
feat(all-in-one): update prettier config, enable format on save Update the VSCode settings.json to include the Prettier VSCode formatter, and enable formatting on save. A new LICENSE file is added to comply with the MIT license due to the open-source nature of the project. The README.md file has now core features and to-dos that should be taken care of as the project continues to evolve. The index.html file is modified to match changes in src/index.tsx. The postcss configuration files are created, and some files are updated. Finally, new files like build.rs, draworder.json, and commands.rs were created
2023-05-02 16:51:22 +02:00
![Tailwind framework](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)
refactor(markdown): update README
2023-05-04 17:14:30 +02:00
![Eslint linter](https://img.shields.io/badge/eslint-3A33D1?style=for-the-badge&logo=eslint&logoColor=white)
![Prettier formatter](https://img.shields.io/badge/prettier-1A2C34?style=for-the-badge&logo=prettier&logoColor=F7BA3E)
feat(all-in-one): update prettier config, enable format on save Update the VSCode settings.json to include the Prettier VSCode formatter, and enable formatting on save. A new LICENSE file is added to comply with the MIT license due to the open-source nature of the project. The README.md file has now core features and to-dos that should be taken care of as the project continues to evolve. The index.html file is modified to match changes in src/index.tsx. The postcss configuration files are created, and some files are updated. Finally, new files like build.rs, draworder.json, and commands.rs were created
2023-05-02 16:51:22 +02:00
## 🏗️ How it works
### Gamedata/Generic
It comes first with fetching data using the `@tauri-apps/api/http` module.
Converting uncoming data into minified JSON file formats.
(No need for avro, parquet, protobuf nor CSV for efficient data compression
and encoding schemas for fast data storing/retrieval)
## 📤 Interesting topics
### 🦀 Rust-related
- [Why serde_json crate is the best choice?](https://blog.logrocket.com/json-and-rust-why-serde_json-is-the-top-choice/)
refactor(markdown): update README
2023-05-04 17:14:30 +02:00
### Misc
```shell
npx cloc . \
--exclude-dir=target,_site,node_modules \
--not-match-f=pnpm-lock.yaml
```
```shell
-------------------------------------------------------------------------------
Language files blank comment code
-------------------------------------------------------------------------------
TypeScript 43 158 19 855
JSON 6 0 0 138
Rust 5 39 81 83
Markdown 1 19 0 45
CSS 2 4 0 30
TOML 1 5 2 27
SVG 1 0 0 24
JavaScript 3 0 1 23
HTML 1 2 0 11
-------------------------------------------------------------------------------
SUM: 63 227 103 1236
-------------------------------------------------------------------------------
```
feat(all-in-one): update prettier config, enable format on save Update the VSCode settings.json to include the Prettier VSCode formatter, and enable formatting on save. A new LICENSE file is added to comply with the MIT license due to the open-source nature of the project. The README.md file has now core features and to-dos that should be taken care of as the project continues to evolve. The index.html file is modified to match changes in src/index.tsx. The postcss configuration files are created, and some files are updated. Finally, new files like build.rs, draworder.json, and commands.rs were created
2023-05-02 16:51:22 +02:00
## 🤝 Credits
refactor(markdown): update README
2023-05-04 17:14:30 +02:00
This wouldn't be possible without [KOZEN](https://github.com/kozennnn)'s help and bare bones the
Reference in New Issue Copy Permalink