Skip to content

Commit 0ddcc9a

Browse files
authored
Update README.md
1 parent 103acfb commit 0ddcc9a

File tree

1 file changed

+49
-18
lines changed

1 file changed

+49
-18
lines changed

README.md

Lines changed: 49 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,57 @@
1-
<!DOCTYPE html>
2-
<html lang="en">
3-
<head>
4-
<meta charset="UTF-8">
5-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6-
<title>FinBot - Your AI Financial Guide</title>
7-
<script src="https://cdn.tailwindcss.com"></script>
8-
<link rel="preconnect" href="https://fonts.googleapis.com">
9-
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
10-
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&display=swap" rel="stylesheet">
11-
<style>
12-
body {
13-
font-family: 'Inter', sans-serif;
14-
background-color: #0d1117;
15-
background-image: radial-gradient(at 0% 0%, #1a2a40 0, transparent 50%), radial-gradient(at 100% 100%, #1a403a 0, transparent 50%);
16-
display: flex;
17-
justify-content: center;
1+
# SHINRA – Gamified AI Finance Learning Platform
2+
3+
## Overview
4+
SHINRA is an AI-powered gamified chatbot designed to teach financial literacy interactively.
5+
It covers trading, stocks, forex, HFT, crypto, and fintech concepts using step-by-step explanations and real-world examples.
6+
The platform gamifies learning with XP, levels, badges, and nano-modules for simulations and quizzes.
7+
8+
## Current Progress
9+
- AI-powered chatbot answers finance-related queries
10+
- Stepwise explanations with examples
11+
- Planned integration of gamification: XP, levels, badges, mini-games
12+
- Future PDF export for chat history
13+
14+
## Next Steps
15+
- Integrate gamified modules: Market Data Visualizer, Trading Simulator, HFT Micro-module, Quiz Module
16+
- Implement daily challenges and rewards
17+
- Add backend storage for user progress and AI interactions
18+
- Deploy full-stack prototype
19+
20+
## Tech Stack
21+
- Frontend: React.js / TailwindCSS / HTML, CSS, JS
22+
- Backend: Node.js / Express or Python Flask
23+
- AI: OpenAI GPT API integration
24+
- Database: MongoDB / PostgreSQL
25+
- PDF Export: jsPDF / Python ReportLab
26+
- Visualization: D3.js / Chart.js
27+
28+
## How to Run
29+
1. Clone repository
30+
2. Install dependencies:
31+
- `npm install` for frontend
32+
- `pip install -r requirements.txt` for backend (Python)
33+
3. Start backend server
34+
4. Start frontend app
35+
5. Interact with SHINRA chatbot and explore gamified learning modules
36+
37+
## Demo
38+
![Chat UI Screenshot](docs/screenshots/chat_ui.png) justify-content: center;
1839
align-items: center;
1940
padding: 1rem;
2041
min-height: 100vh;
2142
}
2243

23-
.chat-container {
44+
.You are SHINRA – Smart Hybrid Intelligence for Next-gen Research & Automation.
45+
46+
Mission: Teach finance (Trading, Forex, HFT, Crypto, Investments, Banking, FinTech) in a gamified, interactive way.
47+
48+
Rules:
49+
1. Answer all finance queries in simple English, step-by-step, with examples.
50+
2. Gamify learning: XP, levels, badges, mini-games.
51+
3. Provide adaptive guidance based on user progress.
52+
4. Support PDF export of chat + achievements.
53+
5. Use friendly, mentor-like tone.
54+
6. Include market data, simulations, and nano-modules guidance. {
2455
max-width: 400px;
2556
width: 100%;
2657
height: 90vh;

0 commit comments

Comments
 (0)