wallstreetlocal
1.0.0
Un sitio web que le permite ver las inversiones de los inversores más grandes de Estados Unidos.
La Comisión de Bolsa y Valores (SEC) mantiene el registro de todas las empresas en los Estados Unidos. Sin embargo, las empresas cuyas tenencias superan los $ 100 millones deben presentar un tipo especial de formulario: el formulario 13F. Este formulario, presentado trimestralmente, revela las tenencias del archivo, proporcionando transparencia en sus actividades de inversión y permitiendo que el público y otros participantes del mercado las controlen.
Sin embargo, el problema es que estas tenencias a menudo son engorrosas para acceder, y el análisis valioso a menudo se oculta detrás de un muro de pago. A través de WallStreetLocal , los archivos 13F de la SEC se vuelven más accesibles y abiertos.
Este repositorio contiene el backend y el frontend para WallStreetLocal.
Para visitar WallStreetLocal, puede ir a wallstreetlocal.com .
También puede ver los recursos importantes utilizados para crear el sitio en la página de recursos o ver la documentación de OpenAPI en la página API.
Para obtener más información, consulte la documentación para la pila de desarrollo de WallStreetLocal a continuación.
Una versión de producción del sitio está alojada en wallstreetlocal.com , pero también es posible autohospedar.
Navegue a la carpeta frontend.
cd frontendInstalar dependencias.
npm installDesplegar.
npm run devO para una construcción de producción, ejecute
npm run build
npm run start Una vez que se completan los pasos anteriores, el frontend debe alojarse en localhost:3000 , con el backend configurado automáticamente en content.wallstreetlocal.com .
Alojar solo el frontend es la forma recomendada de autohospedar, pero si desea que el backend también sea a sí mismo, vea a continuación.
Para ejecutar las compilaciones de desarrollo y producción, deberá tener variables de entorno para API de terceros. La mayoría de las variables de entorno en los archivos de ejemplo proporcionados que puede mantener como es, pero para las claves API deberá visitar los siguientes servicios.
Estos tres servicios diferentes permiten los datos más actualizados y precisos, al tiempo que evitan la limitación de la velocidad.
Aunque se recomienda que apague la telemetría para autohospedaje, puede habilitar la telemetría a través de la variable de entorno TELEMETRY .
Para la telemetría/rastreo/registros, WallStreetLocal usa centinela. Puedes registrarte aquí, o a sí mismo también.
La construcción de desarrollo está hecha principalmente para pruebas, por lo que es ideal para el autohospedaje.
Para ejecutar la aplicación completa, necesita los microservicios que se ejecutan a través de Docker y la aplicación principal que se ejecuta por separado.
Puede encontrar el archivo de composición de desarrollo aquí. También necesitará un archivo .env que se pueda encontrar aquí.
Una vez que tenga todos los archivos de configuración listos, para iniciar la aplicación, ejecute lo siguiente.
Navegue al directorio de backend.
cd backendEjecute los microservicios llamando al archivo de composición de desarrollo.
docker compose -f docker-compose.dev.yaml up -dNota: debe detener estos microservicios después de que haya terminado de usarlos (de lo contrario, desperdiciarán recursos indefinidamente). Para detenerlos, ejecute lo siguiente.
docker compose -f docker-compose.dev.yaml down # Run after you've finished
Instalar dependencias con UV.
Pipx Instalar UV # Más opciones en 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 construcción de producción está hecha para la implementación a escala, por lo que ejecutarla será más engorroso.
Puede encontrar el archivo de composición aquí. Sin embargo, no hay archivo .env , ya que todas las variables de entorno se incluyen en el archivo de composición.
A menos que esté ejecutando la construcción de producción para muchas personas, debe cambiar la siguiente configuración.
localhostUna vez que tenga todos los archivos de configuración listos, para iniciar la aplicación, ejecute lo siguiente.
Navegue al directorio de backend.
cd backendEjecute la aplicación completa con un comando.
docker compose -f docker-compose.prod.yaml upSi cree que puede contribuir a este proyecto, o ha encontrado un error, cree un problema o extraiga una solicitud.
Este proyecto se mantiene únicamente, por lo que es propenso a errores y antipatrones, por favor, llame a donde los ve. ¡Todas las contribuciones son muy apreciadas!
Licencia de MIT
Código de conducta
