44 lines
1.8 KiB
Markdown
44 lines
1.8 KiB
Markdown
<div align="center">
|
|
|
|
|
|
|
|
# **Open Source Stock Analysis for Data Freaks**
|
|
|
|
<h3>
|
|
|
|
[Homepage](https://stocknear.com/) | [Discord](https://discord.com/invite/hCwZMMZ2MT)
|
|
|
|
</h3>
|
|
|
|
[](https://github.com/stocknear/frontend/stargazers)
|
|
|
|
</div>
|
|
|
|
|
|
|
|
# Techstack
|
|
This is the codebase that powers [stocknear's](https://stocknear.com/) frontend, which is an open-source stock analysis & community platform.
|
|
|
|
Built with:
|
|
- [Sveltekit](https://kit.svelte.dev/): Frontend
|
|
- [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.
|
|
|
|
The core idea of stocknear shall always be: ***Fast*** & ***Simple***.
|
|
|
|
If want to contribute to the codebase please follow these guidelines:
|
|
- 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!
|