|
10 | 10 | [](https://tailwindcss.com/)
|
11 | 11 | [](https://nodejs.org/)
|
12 | 12 | [](https://finnhub.io/)
|
| 13 | +[](https://hackstyx.github.io/portfolio-tracker/) |
13 | 14 |
|
14 | 15 | <p align="center">
|
15 | 16 | <strong>A modern, responsive stock portfolio tracker built with React and Node.js</strong>
|
16 | 17 | </p>
|
17 | 18 |
|
18 |
| -[Live Demo](https://portfolio-tracker-hackstyx.vercel.app) • [API Documentation](#-api-endpoints) • [Report Bug](https://github.com/HackStyx/portfolio-tracker/issues) |
| 19 | +[Live Demo](https://portfolio-tracker-hackstyx.vercel.app) • [API Documentation](https://hackstyx.github.io/portfolio-tracker/) • [Report Bug](https://github.com/HackStyx/portfolio-tracker/issues) |
19 | 20 |
|
20 | 21 | > **Note**: Due to the free tier limitations of Render, the initial load of the demo might take 30-60 seconds. If no data appears, please refresh the page. If issues persist, click the logout button to reset the application state. The backend spins down after 15 minutes of inactivity and needs time to restart.
|
21 | 22 |
|
@@ -84,31 +85,48 @@ npm run migrate
|
84 | 85 | npm start
|
85 | 86 | ```
|
86 | 87 |
|
87 |
| -## 🔌 API Endpoints |
| 88 | +## 🔌 API Documentation |
| 89 | + |
| 90 | +Our API is fully documented and available at [https://hackstyx.github.io/portfolio-tracker/](https://hackstyx.github.io/portfolio-tracker/) |
88 | 91 |
|
89 | 92 | ### Base URL
|
90 | 93 | ```
|
91 | 94 | https://portfolio-tracker-backend-y7ne.onrender.com/api
|
92 | 95 | ```
|
93 | 96 |
|
94 |
| -### Portfolio |
| 97 | +### Key Endpoints |
95 | 98 |
|
96 |
| -``` |
97 |
| -GET /api/stocks # Get portfolio stocks |
98 |
| -POST /api/stocks # Add stock |
99 |
| -PUT /api/stocks/:id # Update stock |
100 |
| -DELETE /api/stocks/:id # Remove stock |
| 99 | +#### Portfolio Management |
| 100 | +```http |
| 101 | +GET /stocks # Get all stocks in portfolio |
| 102 | +POST /stocks # Add new stock |
| 103 | +PUT /stocks/:id # Update existing stock |
| 104 | +DELETE /stocks/:id # Remove stock from portfolio |
101 | 105 | ```
|
102 | 106 |
|
103 |
| -### Watchlist |
104 |
| - |
| 107 | +#### Watchlist Management |
| 108 | +```http |
| 109 | +GET /watchlist # Get watchlist items |
| 110 | +POST /watchlist # Add stock to watchlist |
| 111 | +DELETE /watchlist/:id # Remove from watchlist |
105 | 112 | ```
|
106 |
| -GET /api/watchlist # Get watchlist |
107 |
| -POST /api/watchlist # Add to watchlist |
108 |
| -PUT /api/watchlist/:id # Update watchlist item |
109 |
| -DELETE /api/watchlist/:id # Remove from watchlist |
| 113 | + |
| 114 | +#### Market Data |
| 115 | +```http |
| 116 | +GET /stocks/:ticker/quote # Get real-time stock quote |
| 117 | +GET /stocks/:ticker/history # Get historical price data |
| 118 | +GET /stocks/summary # Get portfolio analytics |
110 | 119 | ```
|
111 | 120 |
|
| 121 | +For detailed API documentation including: |
| 122 | +- Request/Response formats |
| 123 | +- Authentication details |
| 124 | +- Rate limiting |
| 125 | +- Error handling |
| 126 | +- Code examples |
| 127 | + |
| 128 | +Visit our [API Documentation](https://hackstyx.github.io/portfolio-tracker/) |
| 129 | + |
112 | 130 | ## ⚡️ Tech Stack
|
113 | 131 |
|
114 | 132 | ### 🎨 Frontend
|
@@ -162,4 +180,17 @@ DELETE /api/watchlist/:id # Remove from watchlist
|
162 | 180 |
|
163 | 181 | ## 📄 License
|
164 | 182 |
|
165 |
| -MIT © [HackStyx](LICENSE) |
| 183 | +This project is licensed under the MIT License. |
| 184 | +[](https://opensource.org/licenses/MIT) |
| 185 | + |
| 186 | +For more information, see the [LICENSE](LICENSE) file in the repository. |
| 187 | + |
| 188 | + |
| 189 | + |
| 190 | +<div align="center"> |
| 191 | + <p>THANK YOU FOR VISITING ❤️</p> |
| 192 | +</div> |
| 193 | + |
| 194 | +<p align="center"> |
| 195 | + <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/footers/gray0_ctp_on_line.svg?sanitize=true" /> |
| 196 | +</p> |
0 commit comments