AmineTMIRI/frontend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
UI of stocknear - Open Source Stock Analysis
3 Commits 1 Branch 0 Tags AGPL-3.0 36 MiB
Svelte 88.6%
TypeScript 10.8%
JavaScript 0.5%
35e8cf35e0
Go to file
Muslem Rahimi 35e8cf35e0
Update README.md
2024-05-26 14:35:52 +02:00
LICENSE Initial commit 2024-05-26 13:27:41 +02:00
README.md Update README.md 2024-05-26 14:35:52 +02:00

README.md

Open Source Stock Analysis & Community Platform for Small Investors.

Homepage | Discord

GitHub Repo stars

Techstack

This is the codebase that powers stocknear's frontend, which is an open-source stock analysis & community platform.

Built with:

Getting started

Coming soon to run stocknear locally on your machine.

Contributing

Stocknear is open-source software and you're welcome to contribute to its development.

The core idea of stocknear shall always be: Simplicity, Maintainable, Readable & Fast in this order.

If want to contribute to the codebase please follow these guidelines:

  • Reducing complexity and increasing readability is a huge plus!
  • Anything you claim is a "speedup" must be benchmarked. In general, the goal is simplicity, so even if your PR makes things marginally faster, you have to consider the tradeoff with maintainablity and readablity.
  • If your PR looks "complex", is a big diff, or adds lots of lines, it won't be reviewed or merged. Consider breaking it up into smaller PRs that are individually clear wins. A common pattern I see is prerequisite refactors before adding new functionality. If you can (cleanly) refactor to the point that the feature is a 3 line change, this is great, and something easy for us to review.