Skip to content

Commit 31665b7

Browse files
committed
done
1 parent 47a08ab commit 31665b7

File tree

1 file changed

+90
-1
lines changed

1 file changed

+90
-1
lines changed

README.md

Lines changed: 90 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,90 @@
1-
# ons_trading
1+
2+
# ONS trading
3+
4+
**ONS Trading** is a web-based portfolio management tool designed for investors and traders who want to optimize their investments using AI-powered allocation and real-time market data.
5+
It allows users to:
6+
7+
- Add and manage assets from global stock markets and cryptocurrencies (using Yahoo Finance symbols).
8+
- View live prices and historical performance.
9+
- Automatically calculate and recommend optimal portfolio allocations using the Online Newton Step (ONS) algorithm.
10+
- Effortlessly update prices and manage capital allocation.
11+
12+
**Who is it for?**
13+
This project is for individual investors, finance enthusiasts, and anyone interested in smarter, data-driven portfolio management with a simple, user-friendly interface.
14+
15+
---
16+
17+
## Badges
18+
19+
[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/Deadcoder001/ons_trading/blob/main/LICENSE.txt)
20+
[![GitHub release downloads](https://img.shields.io/github/downloads/Deadcoder001/ons_trading/latest/total.svg)](https://github.com/Deadcoder001/ons_trading/releases/latest)
21+
22+
## Deployment
23+
24+
You can deploy your Django ONS Trading app on any Linux server, cloud platform, or PaaS that supports Python. Here’s a basic guide for common deployment options:
25+
26+
27+
```bash
28+
pip install -r requirements.txt
29+
python manage.py migrate
30+
python manage.py runserver
31+
```
32+
33+
34+
# Roadmap
35+
36+
## 1. Core Features (Completed)
37+
- [x] Add, view, and delete assets with name and symbol.
38+
- [x] Fetch live prices using yfinance for stocks and crypto.
39+
- [x] Display portfolio with real-time prices.
40+
- [x] Run ONS (Online Newton Step) algorithm for optimal allocation.
41+
- [x] Show recommended allocations and capital distribution.
42+
- [x] Responsive, modern UI with Bootstrap.
43+
44+
## 2. Usability Improvements
45+
- [x] Symbol lookup helper or autocomplete (link to Yahoo Finance or suggest format).
46+
- [x] Asset edit functionality (change name/symbol).
47+
- [x] Asset detail/history view (show price chart for each asset).
48+
- [x]Improved error messages for invalid symbols or price fetch failures.
49+
50+
## 3. Advanced Features
51+
- [x] Support for multiple exchanges (NSE, BSE, NASDAQ, etc.) with dropdown.
52+
- [x] Import/export portfolio as CSV.
53+
- [x] User authentication and personal portfolios.
54+
- [x] Notifications for price changes or rebalancing suggestions.
55+
56+
## 4. Analytics & Visualization
57+
- [x] Portfolio performance chart over time.
58+
- [x] Asset allocation pie chart.
59+
- [x] Risk/return analytics and historical backtesting.
60+
61+
## 5. Integrations & Automation
62+
- [x] Scheduled price updates (via Celery or cron).
63+
- [x] Integration with broker APIs for real trades (optional/advanced).
64+
- [x] Mobile-friendly PWA or native app.
65+
66+
## 6. Documentation & Community
67+
- [x] Complete user guide and FAQ.
68+
- [x] Contribution guidelines for open source.
69+
- [x] Demo video and deployment instructions.
70+
71+
---
72+
73+
**Suggestions and contributions are welcome!**
74+
# Tech Stack
75+
76+
- **Backend:** Django (Python)
77+
- **Frontend:** HTML5, CSS3, Bootstrap 5, JavaScript
78+
- **Database:** SQLite (default, can be switched to PostgreSQL/MySQL)
79+
- **Live Price Data:** [yfinance](https://pypi.org/project/yfinance/) (Yahoo Finance Python API)
80+
- **Numerical Computation:** NumPy
81+
- **Deployment:** Linux server (compatible with Heroku, Render, DigitalOcean, etc.)
82+
- **Version Control:** Git & GitHub
83+
## Screenshots
84+
85+
![App Screenshot](https://github.com/Deadcoder001/ons_trading/blob/main/Screenshot%202025-05-25%20at%209.58.56%E2%80%AFPM.png?raw=true)
86+
87+
88+
## Authors
89+
90+
- [@Deadcoder001](https://www.github.com/Deadcoder001)

0 commit comments

Comments
 (0)