From 36fb9d0f66f71ddb980dabff3342b8fbe80ea674 Mon Sep 17 00:00:00 2001 From: Ettore Date: Sat, 31 Jan 2026 13:49:39 +0100 Subject: [PATCH 1/4] Update README.md add a tag for intro --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0552cca..a354f7b 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ Note: OpenStock is community-built and not a brokerage. Market data may be delay 13. 📜 [License](#license) 14. 🙏 [Acknowledgements](#acknowledgements) -## ✨ Introduction +## ✨ Introduction OpenStock is a modern stock market app powered by Next.js (App Router), shadcn/ui and Tailwind CSS, Better Auth for authentication, MongoDB for persistence, Finnhub for market data, and TradingView widgets for charts and market views. From 625cdebd9ec2ccc141118ded9b85f79464ce0027 Mon Sep 17 00:00:00 2001 From: Ettore Date: Sat, 31 Jan 2026 13:52:16 +0100 Subject: [PATCH 2/4] Fix links in readme --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a354f7b..7bef429 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ We believe there’s a better way. Because the future belongs to those who build it openly. -## ⚙️ Tech Stack +## ⚙️ Tech Stack Core - Next.js 15 (App Router), React 19 @@ -94,7 +94,7 @@ Automation & Comms Language composition - TypeScript (~93.4%), CSS (~6%), JavaScript (~0.6%) -## 🔋 Features +## 🔋 Features - Authentication - Email/password auth with Better Auth + MongoDB adapter @@ -120,7 +120,7 @@ Language composition - Keyboard shortcut - Cmd/Ctrl + K for quick actions/search -## 🤸 Quick Start +## 🤸 Quick Start Prerequisites - Node.js 20+ and pnpm or npm @@ -171,7 +171,7 @@ npm run build && npm start Open http://localhost:3000 to view the app. -## 🐳 Docker Setup +## 🐳 Docker Setup You can run OpenStock and MongoDB easily with Docker Compose. @@ -225,7 +225,7 @@ volumes: mongo-data: ``` -## 🔐 Environment Variables +## 🔐 Environment Variables Create `.env` at the project root. Choose either a hosted MongoDB (Atlas) URI or the local Docker URI. @@ -291,7 +291,7 @@ Notes - In production, prefer a dedicated SMTP provider over a personal Gmail. - Do not hardcode secrets in the Dockerfile; use `.env` and Compose. -## 🧱 Project Structure +## 🧱 Project Structure ``` app/ @@ -330,7 +330,7 @@ components.json # shadcn config public/assets/images/ # logos and screenshots ``` -## 📡 Data & Integrations +## 📡 Data & Integrations - Finnhub - Stock search, company profiles, and market news. @@ -355,7 +355,7 @@ public/assets/images/ # logos and screenshots - Gmail transport. Update credentials or switch to your SMTP provider. - Templates for welcome and news summary emails. -## 🧪 Scripts & Tooling +## 🧪 Scripts & Tooling Package scripts - `dev`: Next.js dev server with Turbopack @@ -370,7 +370,7 @@ Developer experience - shadcn/ui components with Radix primitives - cmdk command palette, next-themes, lucide-react icons -## 🤝 Contributing +## 🤝 Contributing You belong here. Whether you’re a student, a self-taught dev, or a seasoned engineer — contributions are welcome. @@ -379,18 +379,18 @@ You belong here. Whether you’re a student, a self-taught dev, or a seasoned en - Keep PRs focused; add screenshots for UI changes - Be kind, guide beginners, no gatekeeping — that’s the ODS way -## 🛡️ Security +## 🛡️ Security If you discover a vulnerability: - Do not open a public issue - Email: opendevsociety@cc.cc - We’ll coordinate responsible disclosure and patch swiftly -## 📜 License +## 📜 License OpenStock is and will remain free and open for everyone. This project is licensed under the AGPL-3.0 License - see the LICENSE file for details. -## 🙏 Acknowledgements +## 🙏 Acknowledgements - Finnhub for accessible market data - TradingView for embeddable market widgets From 2f05090799552d6cf6950c97489ef48ca5b073bb Mon Sep 17 00:00:00 2001 From: "Mr. Algorithm" <11aravipratapsingh@gmail.com> Date: Sun, 1 Feb 2026 02:09:42 +0530 Subject: [PATCH 3/4] Update README.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7bef429..ab74b7f 100644 --- a/README.md +++ b/README.md @@ -383,8 +383,8 @@ You belong here. Whether you’re a student, a self-taught dev, or a seasoned en If you discover a vulnerability: - Do not open a public issue -- Email: opendevsociety@cc.cc -- We’ll coordinate responsible disclosure and patch swiftly +- Email: opendevsociety@cc.cc +- We'll coordinate responsible disclosure and patch swiftly ## 📜 License From ecf0a445e447efdda39d256cb7cd5f3fe9b5bcaf Mon Sep 17 00:00:00 2001 From: "Mr. Algorithm" <11aravipratapsingh@gmail.com> Date: Sun, 1 Feb 2026 03:52:18 +0530 Subject: [PATCH 4/4] Update README with new contributor details Added contributor information for ettoreciolli1. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index ab74b7f..a82fbc9 100644 --- a/README.md +++ b/README.md @@ -408,6 +408,8 @@ OpenStock is and will remain free and open for everyone. This project is license - [Priyanshuu00007](https://github.com/Priyanshuu00007) - Created the official OpenStock logo and contributed to the project’s visual identity. - [chinnsenn](https://github.com/chinnsenn) - Set up Docker configuration for the repository, ensuring a smooth development and deployment process. - [koevoet1221](https://github.com/koevoet1221) - Resolved MongoDB Docker build issues, improving the project’s overall stability and reliability. +- [ettoreciolli1](https://github.com/ettoreciolli1) - updated Readme + ## ❤️ Partners & Backers