|
9 | 9 | [](https://www.mysql.com/)
|
10 | 10 | [](https://tailwindcss.com/)
|
11 | 11 | [](https://nodejs.org/)
|
| 12 | +[](https://finnhub.io/) |
12 | 13 |
|
13 | 14 | <p align="center">
|
14 | 15 | <strong>A modern, responsive stock portfolio tracker built with React and Node.js</strong>
|
15 | 16 | </p>
|
16 | 17 |
|
17 | 18 | [Live Demo](https://portfolio-tracker-hackstyx.vercel.app) • [API Documentation](#-api-endpoints) • [Report Bug](https://github.com/HackStyx/portfolio-tracker/issues)
|
18 | 19 |
|
| 20 | +> **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 | +
|
19 | 22 | 
|
20 | 23 |
|
21 | 24 | </div>
|
|
26 | 29 | - 👀 **Watchlist** - Monitor potential investments
|
27 | 30 | - 🌓 **Dark/Light Mode** - Easy on the eyes, day and night
|
28 | 31 | - 📱 **Fully Responsive** - Perfect on desktop and mobile
|
29 |
| -- 🔄 **Live Updates** - Stock prices update automatically |
30 |
| -- 📈 **Price History** - Visualize stock performance |
| 32 | +- 🔄 **Live Updates** - Real-time stock prices via Finnhub API |
| 33 | +- 📈 **Price History** - Visualize stock performance with historical data |
| 34 | +- 💹 **Market Data** - Real-time quotes and market status tracking |
| 35 | +- 🎯 **Price Targets** - Set and monitor stock price targets |
31 | 36 |
|
32 | 37 | ## 🚀 Quick Start
|
33 | 38 |
|
|
36 | 41 | - Node.js 14+
|
37 | 42 | - npm or yarn
|
38 | 43 | - MySQL
|
| 44 | +- Finnhub API Key (get one at [finnhub.io](https://finnhub.io/)) |
39 | 45 |
|
40 | 46 | ### Frontend Setup
|
41 | 47 |
|
@@ -69,6 +75,7 @@ npm install
|
69 | 75 | DATABASE_URL=mysql://user:password@localhost:3306/portfolio_tracker
|
70 | 76 | PORT=5000
|
71 | 77 | NODE_ENV=development
|
| 78 | +FINNHUB_API_KEY=your_finnhub_api_key |
72 | 79 | ```
|
73 | 80 |
|
74 | 81 | 3. Run migrations and start:
|
@@ -104,25 +111,54 @@ DELETE /api/watchlist/:id # Remove from watchlist
|
104 | 111 |
|
105 | 112 | ## ⚡️ Tech Stack
|
106 | 113 |
|
107 |
| -### Frontend |
108 |
| -- React + Vite |
109 |
| -- TailwindCSS |
110 |
| -- Framer Motion |
111 |
| -- Tremor Charts |
112 |
| -- Axios |
113 |
| - |
114 |
| -### Backend |
115 |
| -- Node.js |
116 |
| -- Express |
117 |
| -- MySQL |
118 |
| -- Knex.js |
| 114 | +### 🎨 Frontend |
| 115 | +- **Framework**: [React](https://reactjs.org/) - A JavaScript library for building user interfaces |
| 116 | +- **Build Tool**: [Vite](https://vitejs.dev/) - Next generation frontend tooling |
| 117 | +- **Styling**: |
| 118 | + - [TailwindCSS](https://tailwindcss.com/) - Utility-first CSS framework |
| 119 | + - [Tremor](https://www.tremor.so/) - React library for dashboards and charts |
| 120 | + - [Framer Motion](https://www.framer.com/motion/) - Animation library |
| 121 | +- **State Management**: React Context API |
| 122 | +- **HTTP Client**: [Axios](https://axios-http.com/) - Promise based HTTP client |
| 123 | + |
| 124 | +### 🛠 Backend |
| 125 | +- **Runtime**: [Node.js](https://nodejs.org/) - JavaScript runtime |
| 126 | +- **Framework**: [Express](https://expressjs.com/) - Web framework for Node.js |
| 127 | +- **Database**: [MySQL](https://www.mysql.com/) - Open-source relational database |
| 128 | +- **ORM**: [Sequelize](https://sequelize.org/) - Modern TypeScript and Node.js ORM |
| 129 | +- **Market Data**: [Finnhub](https://finnhub.io/) - Real-time RESTful APIs for stocks |
| 130 | +- **API Documentation**: OpenAPI/Swagger |
| 131 | + |
| 132 | +### 🚀 DevOps & Infrastructure |
| 133 | +- **Frontend Hosting**: [Vercel](https://vercel.com/) |
| 134 | + - Zero-config deployments |
| 135 | + - Automatic HTTPS |
| 136 | + - Edge Network for optimal performance |
| 137 | +- **Backend Hosting**: [Render](https://render.com/) |
| 138 | + - Containerized deployment |
| 139 | + - Automatic scaling |
| 140 | + - Built-in monitoring |
| 141 | +- **Database Hosting**: [Railway](https://railway.app/) |
| 142 | + - Managed MySQL database |
| 143 | + - Automated backups |
| 144 | + - High availability |
| 145 | + |
| 146 | +### 📦 Additional Tools |
| 147 | +- **Version Control**: Git & GitHub |
| 148 | +- **Code Quality**: ESLint & Prettier |
| 149 | +- **API Testing**: Postman |
| 150 | +- **Environment Variables**: dotenv |
| 151 | +- **Security**: CORS, Helmet |
| 152 | +- **Real-time Data**: WebSocket (planned) |
119 | 153 |
|
120 | 154 | ## ⚠️ Limitations
|
121 | 155 |
|
122 |
| -- Uses simulated stock data |
| 156 | +- Uses simulated stock data when Finnhub API rate limit is reached |
123 | 157 | - Single-user environment
|
124 | 158 | - Price updates every minute
|
125 | 159 | - Best viewed in modern browsers
|
| 160 | +- Backend spins down after 15 minutes of inactivity and needs time to restart |
| 161 | +- Limited to 60 API calls per minute (Finnhub free tier) |
126 | 162 |
|
127 | 163 | ## 📄 License
|
128 | 164 |
|
|
0 commit comments