AmineTMIRI/frontend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Muslem Rahimi 2024-12-02 23:22:39 +01:00 committed by GitHub
parent 9c2556b1e4
commit c3088b0d4e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -14,7 +14,7 @@
# Techstack
This is the codebase that powers [stocknear's](https://stocknear.com/) frontend, which is an open-source stock analysis & community platform.
This is the codebase that powers [Stocknear's](https://stocknear.com/) frontend, which is an open-source stock analysis platform.
Built with:
@ -22,25 +22,19 @@ Built with:
- [Tailwindcss](https://tailwindcss.com/): Styling
- [DaisyUI](https://daisyui.com/): Styling
# 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.
Stocknear is an open-source project, proudly maintained by Muslem Rahimi.
The core idea of stocknear shall always be: **_Fast_** & **_Simple_**.
We are not accepting pull requests. However, you are more than welcome to fork the project and customize it to suit your needs.
If want to contribute to the codebase please follow these guidelines:
The core idea of stocknear shall always be: **_Fast_**, **_Simple_** & **_Efficient_**.
- Refactoring slow code into fast code is a huge plus!
- Reducing complexity and increasing simplicity/readability is a huge plus!
- 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.
# Support ❤️
If you love the idea of stocknear and want to support our mission you can help us in two ways:
- Become a [Pro Member](https://stocknear.com/pricing) of stocknear to get unlimited feature access to enjoy the platform to the fullest.
- You can donate money via [Ko-fi](https://ko-fi.com/stocknear) to help us pay the servers & data providers to keep everything running!
- You can sponsor us via [Github](https://github.com/sponsors/stocknear) to help us pay the servers & data providers to keep everything running!