wallstreetlocal
1.0.0
Um site que permite visualizar os investimentos dos maiores investidores da América.
A Comissão de Valores Mobiliários (SEC) mantém o registro de todas as empresas nos Estados Unidos. As empresas cujas participações superam US $ 100 milhões, porém, devem arquivar um tipo especial de formulário: o formulário 13F. Esse formulário, apresentado trimestralmente, divulga as participações do arquivador, fornecendo transparência em suas atividades de investimento e permitindo que o público e outros participantes do mercado os monitorassem.
O problema, porém, é que essas participações geralmente são pesadas para acessar, e uma análise valiosa é frequentemente escondida atrás de um paywall. Através de Wallstreetlocal , os arquivadores 13F da SEC se tornam mais acessíveis e abertos.
Este repositório mantém o back -end e o front -end para Wallstreetlocal.
Para visitar o Wallstreetlocal, você pode ir para wallstreetlocal.com .
Você também pode ver recursos importantes usados para criar o site na página de recursos ou visualizar a documentação do OpenAPI na página da API.
Para obter mais informações, consulte a documentação para a pilha de desenvolvimento da Wallstreetlocal abaixo.
Uma versão de produção do site está hospedada em wallstreetlocal.com , mas também é possível se auto-hospedeiro.
Navegue até a pasta front -end.
cd frontendInstalar dependências.
npm installImplantar.
npm run devOu para uma construção de produção, execute
npm run build
npm run start Depois que as etapas acima forem concluídas, o front -end deve ser hospedado no localhost:3000 , com o back -end configurado automaticamente para content.wallstreetlocal.com .
Somente hospedar o front-end é a maneira recomendada de auto-anfitrião, mas se você deseja se auto-hospedar o back-end também, veja abaixo.
Para executar tanto o desenvolvimento quanto a produção, você precisará ter variáveis ambientais para APIs de terceiros. A maioria das variáveis de ambiente nos arquivos de exemplo fornecidos que você pode manter como está, mas para as teclas da API, você precisará visitar os seguintes serviços.
Esses três serviços diferentes permitem os dados mais atualizados e precisos, além de evitar limitação de taxa.
Embora seja recomendável que você desligue a telemetria para auto-hospedagem, você pode permitir a telemetria através da variável de ambiente TELEMETRY .
Para telemetria/rastreamento/logs, o WallStreetlocal usa sentinela. Você pode se inscrever aqui, ou se auto-hospedeiro também.
A construção do desenvolvimento é feita principalmente para teste, por isso é ideal para auto-hospedagem.
Para executar o aplicativo completo, você precisa dos microsserviços que passam pelo Docker e o aplicativo principal em execução separadamente.
Você pode encontrar o arquivo de composição de desenvolvimento aqui. Você também precisará de um arquivo .env que pode ser encontrado aqui.
Depois de ter todos os arquivos de configuração prontos, para iniciar o aplicativo, execute o seguinte.
Navegue até o diretório de back -end.
cd backendExecute os microsserviços chamando o arquivo de composição de desenvolvimento.
docker compose -f docker-compose.dev.yaml up -dNOTA: Você deve interromper esses microsserviços depois que terminar de usá -los (caso contrário, eles desperdiçarão recursos indefinidamente). Para detê -los, execute o seguinte.
docker compose -f docker-compose.dev.yaml down # Run after you've finished
Instale dependências com UV.
PiPX Instale UV # Mais opções em https://docs.astral.sh/uv/getting-started/installation/ uv sincronização
4. Create and edit the `.env` file using `.env.example`.
5. Run the main application.
```bash
uv run python main.py
A construção da produção é feita para implantar em escala; portanto, a execução será mais pesada.
Você pode encontrar o arquivo de composição aqui. Não há arquivo .env , pois todas as variáveis de ambiente estão incluídas no arquivo de composição.
A menos que você esteja executando a produção de produção para muitas pessoas, você deve alterar as seguintes configurações.
localhostDepois de ter todos os arquivos de configuração prontos, para iniciar o aplicativo, execute o seguinte.
Navegue até o diretório de back -end.
cd backendExecute o aplicativo inteiro com um comando.
docker compose -f docker-compose.prod.yaml upSe você acha que pode contribuir para este projeto ou encontrar um bug, criar um problema ou solicitar a solicitação.
Este projeto é mantido exclusivamente, por isso é propenso a insetos e anti-padrões, ligue para onde você os vê. Todas as contribuições são muito apreciadas!
MIT Licença
Código de Conduta
