Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jzombie/etf-matcher
https://github.com/jzombie/etf-matcher
docker etfs investing investment-tools machine-learning market-analysis rust-wasm stocks typescript-react
Last synced: 2 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/jzombie/etf-matcher
- Owner: jzombie
- License: mit
- Created: 2024-07-02T18:42:24.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-10-24T20:24:25.000Z (21 days ago)
- Last Synced: 2024-10-25T17:57:19.178Z (20 days ago)
- Topics: docker, etfs, investing, investment-tools, machine-learning, market-analysis, rust-wasm, stocks, typescript-react
- Language: TypeScript
- Homepage: https://ETFMatcher.com
- Size: 2.17 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ETF Matcher
Source code for up and coming [ETFMatcher.com](https://etfmatcher.com), a platform designed to help users customize a virtual portfolio with potential fractional shares and find ETFs that closely match their investment goals.
## Requirements
- A Unix terminal shell (such as Bash or Zsh)
- Docker version 26.1.3 (may work with earlier versions of Docker)
- Data (data is not provided directly in this open-source repo; you may need to mock it yourself)
- A compatible .env file (no documentation provided on what to use for this)
### Optional
- make (utility) - Helpful.
You can skip using Docker altogether if that's your thing, but it will be harder to build.
## Development
```bash
make build-dev
make start-dev
```
Other development commands are available by running:
```bash
make help # Or just `make`
```
## Deployment
```bash
make build-prod
```
Built artifacts will be written to `{project_root}/dist`.
## Platform Testing
Thanks to [BrowserStack Open-Source Program](https://www.browserstack.com/open-source) for providing us with a free account which lets us test on real devices and operating systems.
## Code Reviews
Code reviews powered by [https://coderabbit.ai/](https://coderabbit.ai/) (as of August 22, 2024).
## License
[MIT License](LICENSE) (c) 2024 Jeremy Harris.