wallstreetlocal
1.0.0
Un site Web qui vous permet de voir les investissements des plus grands investisseurs américains.
La Securities and Exchange Commission (SEC) tient compte de chaque entreprise aux États-Unis. Les sociétés dont les avoirs dépassent 100 millions de dollars sont tenus de déposer un type spécial de formulaire: le formulaire 13F. Ce formulaire, déposé tous les trimestres, révèle les avoirs du fichier, offrant une transparence dans leurs activités d'investissement et permettant au public et à d'autres acteurs du marché de les surveiller.
Le problème cependant, c'est que ces avoirs sont souvent lourds à l'accès, et une analyse précieuse est souvent cachée derrière un mur payant. Grâce à WallstreetLocal , les déclarants 13F de la SEC deviennent plus accessibles et ouverts.
Ce référentiel contient le backend et le frontend pour WallStreetLocal.
Pour visiter le WallStreetLocal, vous pouvez aller sur wallstreetlocal.com .
Vous pouvez également voir des ressources importantes utilisées pour créer le site sur la page des ressources ou afficher la documentation OpenAPI sur la page API.
Pour plus d'informations, consultez la documentation de la pile de développement de WallStreetLocal ci-dessous.
Une version de production du site est hébergée sur wallstreetlocal.com , mais il est également possible d'auto-héberger.
Accédez au dossier Frontend.
cd frontendInstallez les dépendances.
npm installDéployer.
npm run devOu pour une construction de production, courez
npm run build
npm run start Une fois les étapes ci-dessus terminées, le frontend doit être hébergé sur localhost:3000 , le backend configuré automatiquement sur content.wallstreetlocal.com .
Héberger le frontend seul est le moyen recommandé d'auto-héberger, mais si vous voulez également héberger le backend, voir ci-dessous.
Pour exécuter à la fois le développement et les constructions de production, vous devrez avoir des variables d'environnement pour les API tiers. La plupart des variables d'environnement dans les fichiers d'exemples fournis que vous pouvez conserver tels quels, mais pour les clés API, vous devrez visiter les services suivants.
Ces trois services différents permettent les données les plus à jour et les plus précises, tout en évitant la limitation des taux.
Bien qu'il soit recommandé de désactiver la télémétrie pour l'auto-hébergement, vous pouvez activer la télémétrie via la variable d'environnement TELEMETRY .
Pour la télémétrie / traçage / les journaux, WallStreetLocal utilise la sentinelle. Vous pouvez vous inscrire ici, ou l'auto-hébergement aussi.
La construction de développement est principalement conçue pour les tests, il est donc idéal pour l'auto-hébergement.
Pour exécuter l'application complète, vous avez besoin que les microservices fonctionnent via Docker et l'application principale s'exécutant séparément.
Vous pouvez trouver le fichier de composition de développement ici. Vous aurez également besoin d'un fichier .env qui peut être trouvé ici.
Une fois que vous avez tous les fichiers de configuration prêts, pour démarrer l'application, exécutez ce qui suit.
Accédez au répertoire backend.
cd backendExécutez les microservices en appelant le fichier de développement de développement.
docker compose -f docker-compose.dev.yaml up -dRemarque: vous devez arrêter ces microservices une fois que vous les avez terminés (sinon ils gaspilleront indéfiniment les ressources). Pour les arrêter, exécutez ce qui suit.
docker compose -f docker-compose.dev.yaml down # Run after you've finished
Installez les dépendances avec UV.
pipx install uv # Plus d'options sur 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
La construction de production est faite pour le déploiement à grande échelle, donc l'exécution sera plus lourde.
Vous pouvez trouver le fichier Compose ici. Il n'y a cependant aucun fichier .env , car toutes les variables d'environnement sont incluses dans le fichier Compose.
À moins que vous ne fonctionnez la construction de production pour de nombreuses personnes, vous devez modifier les paramètres suivants.
localhostUne fois que vous avez tous les fichiers de configuration prêts, pour démarrer l'application, exécutez ce qui suit.
Accédez au répertoire backend.
cd backendExécutez toute l'application avec une commande.
docker compose -f docker-compose.prod.yaml upSi vous pensez que vous pouvez contribuer à ce projet ou si vous avez trouvé un bug, créez une demande de problème ou de traction.
Ce projet est uniquement maintenu afin qu'il soit sujet aux bugs et aux anti-motifs, veuillez les appeler où vous les voyez. Toutes les contributions sont très appréciées!
Licence MIT
Code de conduite
