wallstreetlocal
1.0.0
Eine Website, auf der Sie die Investitionen der größten Investoren Amerikas anzeigen können.
Die Securities and Exchange Commission (SEC) verzeichnet jedes Unternehmen in den USA. Unternehmen, deren Beteiligungen jedoch 100 Millionen US -Dollar überschreiten, müssen jedoch einen speziellen Formulartyp einreichen: das 13F -Formular. Dieses vierteljährliche Formular gibt die Bestände des Filer offen, die Transparenz in ihre Investitionstätigkeiten verleiht und es den öffentlichen und anderen Marktteilnehmern ermöglicht, sie zu überwachen.
Das Problem ist jedoch, dass diese Bestände oft umständlich sind, um zugreifen zu können, und wertvolle Analysen sind häufig hinter einer Paywall versteckt. Durch Wallstreetlocal werden die 13F -Filer der SEC zugänglicher und offener.
Dieses Repository enthält das Backend und Frontend für Wallstreetlocal.
Um die Wallstreetlocal zu besuchen, können Sie auf wallstreetlocal.com gehen.
Sie können auch wichtige Ressourcen sehen, die zum Erstellen der Website auf der Ressourcenseite erstellt wurden, oder die OpenAPI -Dokumentation auf der API -Seite anzeigen.
Weitere Informationen finden Sie in der Dokumentation für den Entwicklungsstapel von Wallstreetlocal.
Eine Produktionsversion der Site wird bei wallstreetlocal.com gehostet, ist jedoch auch möglich, sich selbst abzuhalten.
Navigieren Sie zum Frontend -Ordner.
cd frontendAbhängigkeiten installieren.
npm installEinsetzen.
npm run devOder für einen Produktionsbau, leiten Sie
npm run build
npm run start Sobald die oben genannten Schritte ausgeschlossen sind, sollte der Frontend bei localhost:3000 gehostet werden, wobei das Backend automatisch in content.wallstreetlocal.com konfiguriert ist.
Allein das Hosting der Frontend ist die empfohlene Art und Weise, sich selbst zu veranstalten, aber wenn Sie auch das Backend selbst veranstalten möchten, siehe unten.
Um sowohl die Entwicklungs- als auch die Produktionsergebnisse durchzuführen, müssen Sie Umgebungsvariablen für APIs Dritter haben. Die meisten Umgebungsvariablen in den bereitgestellten Beispieldateien, die Sie so halten können, müssen Sie jedoch für die API -Schlüssel die folgenden Dienste besuchen.
Diese drei verschiedenen Dienste ermöglichen die aktuellsten und genauesten Daten und vermeiden gleichzeitig die Ratenlimiting.
Obwohl empfohlen wird, die Telemetrie für Selbsthosting auszuschalten, können Sie die Telemetrie durch die TELEMETRY aktivieren.
Für Telemetrie/Tracing/Logs verwendet Wallstreetlocal Sentry. Sie können sich hier anmelden oder das auch selbst veranstaltet.
Der Entwicklungsbau ist hauptsächlich zum Testen hergestellt, daher ist sie ideal zum Selbstveranstalter.
Um die vollständige App auszuführen, benötigen Sie die Microservices, die über Docker ausgeführt werden, und die Hauptanwendung, die separat ausgeführt wird.
Hier finden Sie die Entwicklungskomponierungsdatei. Sie benötigen auch eine .env -Datei, die hier gefunden werden kann.
Wenn Sie alle Konfigurationsdateien bereit haben, um die App zu starten, führen Sie Folgendes aus.
Navigieren Sie zum Backend -Verzeichnis.
cd backendFühren Sie die MicroServices aus, indem Sie die Entwicklungskomponierungsdatei aufrufen.
docker compose -f docker-compose.dev.yaml up -dHinweis: Sie sollten diese Microservices stoppen, nachdem Sie sie verwendet haben (da sie ansonsten auf unbestimmte Zeit Ressourcen verschwenden). Um sie zu stoppen, laufen Sie Folgendes.
docker compose -f docker-compose.dev.yaml down # Run after you've finished
Installieren Sie Abhängigkeiten mit UV.
PIPX Installieren Sie UV # Weitere Optionen unter https://docs.astral.sh/uv/getting-started/installation/ UV Sync
4. Create and edit the `.env` file using `.env.example`.
5. Run the main application.
```bash
uv run python main.py
Der Produktionsaufbau wird für den Einsatz im Maßstab durchgeführt. Das Ausführen wird daher umständlicher sein.
Hier finden Sie die Komponierungsdatei. Es gibt jedoch keine .env -Datei, da alle Umgebungsvariablen in der Komponierungsdatei enthalten sind.
Wenn Sie den Produktionsbau nicht für viele Menschen ausführen, sollten Sie die folgenden Einstellungen ändern.
localhost abWenn Sie alle Konfigurationsdateien bereit haben, um die App zu starten, führen Sie Folgendes aus.
Navigieren Sie zum Backend -Verzeichnis.
cd backendFühren Sie die gesamte Anwendung mit einem Befehl aus.
docker compose -f docker-compose.prod.yaml upWenn Sie der Meinung sind, dass Sie zu diesem Projekt beitragen können oder einen Fehler gefunden haben, erstellen Sie ein Problem oder eine Anfrage.
Dieses Projekt ist ausschließlich beibehalten, sodass es anfällig für Fehler und Anti-Muster ist. Rufen Sie sie bitte an, wo Sie sie sehen. Alle Beiträge werden sehr geschätzt!
MIT -Lizenz
Verhaltenskodex
