Skip to content

Commit 3b8d776

Browse files
haxgunhaxgun
committed
docs(readme): add Tools and Technologies section
1 parent e77eeb8 commit 3b8d776

File tree

1 file changed

+49
-22
lines changed

1 file changed

+49
-22
lines changed

‎README.md‎

Lines changed: 49 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,37 +12,64 @@
1212
[![Forks](https://img.shields.io/github/forks/haxgun/Valory?style=flat)](https://github.com/haxgun/Valory/forks)
1313
[![Issues](https://img.shields.io/github/issues/haxgun/Valory?style=flat)](https://github.com/haxgun/Valory/issues)
1414

15-
**Valory** is a feature-rich tool that provides a sleek and customizable rank overlay for **Valorant** streamers.
16-
It’s perfect for enhancing your stream’s visuals while keeping your viewers engaged with up-to-date stats.
15+
**Valory** is a feature-rich tool that provides a sleek and customizable rank overlay for **Valorant** streamers.
16+
It’s perfect for enhancing your stream’s visuals while keeping your viewers engaged with up-to-date stats.
1717

18-
This project started as a fork of [davizeragod](https://davizeragod.github.io/) but has since grown into a fully independent and unique tool.
19-
Inspired by [tracker.gg/overlays](https://tracker.gg/overlays), Valory combines aesthetics with functionality to elevate your streaming experience.
18+
This project started as a fork of [davizeragod](https://davizeragod.github.io/) but has since grown into a fully independent and unique tool.
19+
Inspired by [tracker.gg/overlays](https://tracker.gg/overlays), Valory combines aesthetics with functionality to elevate your streaming experience.
2020

2121
</div>
2222

2323
---
2424

2525
## ✨ Features
2626

27-
Valory is packed with powerful features to ensure you get the best experience:
27+
Valory is packed with powerful features to ensure you get the best experience:
2828

29-
- 📊 **Real-Time Updates:** Instantly fetch and display the latest game stats during your stream.
30-
- 💅🏻 **Modern, Stylish Design:** Beautiful visuals designed to blend seamlessly into any stream setup.
31-
- 🎨 **Fully Customizable:** Adjust colors, layouts, and more to match your personal branding.
32-
- 💸 **100% Free:** No hidden costs—accessible to everyone.
33-
- 🛠️ **Simple Setup:** Configure once and enjoy a hassle-free experience with minimal maintenance.
34-
- 🔧 **Integration-Friendly:** Easily add to OBS, Streamlabs, or any streaming software.
29+
- 📊 **Real-Time Updates:** Instantly fetch and display the latest game stats during your stream.
30+
- 💅🏻 **Modern, Stylish Design:** Beautiful visuals designed to blend seamlessly into any stream setup.
31+
- 🎨 **Fully Customizable:** Adjust colors, layouts, and more to match your personal branding.
32+
- 💸 **100% Free:** No hidden costs—accessible to everyone.
33+
- 🛠️ **Simple Setup:** Configure once and enjoy a hassle-free experience with minimal maintenance.
34+
- 🔧 **Integration-Friendly:** Easily add to OBS, Streamlabs, or any streaming software.
35+
36+
---
37+
38+
## 🛠 Tools and Technologies
39+
40+
This project leverages a modern and powerful tech stack to deliver high performance, scalability, and developer convenience. Below is a breakdown of the key tools and technologies used:
41+
42+
### Frontend
43+
44+
- **🌟 Vue 3:** The core frontend framework for building reactive and user-friendly interfaces.
45+
- **⚡ Vite:** A lightning-fast build tool and development server for modern web projects.
46+
- **💬 i18n:** Internationalization support for delivering content in multiple languages.
47+
- **✨ Prettier:** Code formatter to ensure consistent styling across the project.
48+
- **🚨 ESLint:** Linting tool for enforcing code quality and best practices.
49+
- **🔵 TypeScript:** Adds static typing to JavaScript, enhancing maintainability and scalability.
50+
51+
### Backend
52+
53+
- **🐍 FastAPI:** High-performance Python web framework with easy-to-use async support.
54+
- **⚙️ SQLAlchemy:** SQL toolkit and ORM for interacting with the database in a Pythonic way.
55+
- **📜 Alembic:** Database migrations for version control and schema evolution.
56+
- **⚡ asyncpg:** High-performance asynchronous PostgreSQL driver for Python.
57+
58+
### Database
59+
60+
- **🐘 PostgreSQL:** A powerful and open-source relational database system, used as the primary database for production.
61+
- **📂 SQLite:** A lightweight, file-based database, used in debug mode for local development and testing.
3562

3663
---
3764

3865
## 🚀 Getting Started
3966

4067
### 🖥️ Hosting Your Overlay
4168

42-
1. Visit the **[official website](https://overlay.haxgun.ru)**.
43-
2. Configure your overlay with the available options.
44-
3. Copy the provided URL.
45-
4. Add it to your streaming software as a browser source, and you're ready to go!
69+
1. Visit the **[official website](https://overlay.haxgun.ru)**.
70+
2. Configure your overlay with the available options.
71+
3. Copy the provided URL.
72+
4. Add it to your streaming software as a browser source, and you're ready to go!
4673

4774
---
4875

@@ -60,18 +87,18 @@ We believe in open-source collaboration! Here’s how you can contribute:
6087

6188
**Valory** is the result of community inspiration and collaboration. A special thank you to:
6289

63-
- 🖌️ **[davizeragod/davizeragod.github.io](https://github.com/davizeragod/davizeragod.github.io):** The project that laid the foundation for Valory.
64-
- 🔍 **[Henrik-3/unofficial-valorant-api](https://github.com/Henrik-3/unofficial-valorant-api):** The robust API powering accurate and up-to-date stats.
65-
- 🎨 **Inspiration from [tracker.gg](https://tracker.gg):** For showcasing the potential of creative overlays.
90+
- 🖌️ **[davizeragod/davizeragod.github.io](https://github.com/davizeragod/davizeragod.github.io):** The project that laid the foundation for Valory.
91+
- 🔍 **[Henrik-3/unofficial-valorant-api](https://github.com/Henrik-3/unofficial-valorant-api):** The robust API powering accurate and up-to-date stats.
92+
- 🎨 **Inspiration from [tracker.gg](https://tracker.gg):** For showcasing the potential of creative overlays.
6693

67-
Your work inspires us to keep building and improving! 💖
94+
Your work inspires us to keep building and improving! 💖
6895

6996
---
7097

7198
## 📜 License
7299

73-
**Valory** is licensed under the **[MIT License](https://github.com/haxgun/valory/blob/main/LICENSE)**, ensuring that:
100+
**Valory** is licensed under the **[MIT License](https://github.com/haxgun/valory/blob/main/LICENSE)**, ensuring that:
74101

75-
- ✅ **Freedom:** Use, copy, modify, and distribute the project for personal or commercial purposes.
102+
- ✅ **Freedom:** Use, copy, modify, and distribute the project for personal or commercial purposes.
76103
- 🛠️ **Flexibility:** Tailor the code to meet your needs.
77-
- 🌍 **Community:** Share improvements and contribute back to the project while respecting its creators.
104+
- 🌍 **Community:** Share improvements and contribute back to the project while respecting its creators.

0 commit comments

Comments
 (0)