wallstreetlocal
1.0.0
Веб -сайт, который позволяет вам просматривать инвестиции крупнейших инвесторов Америки.
Комиссия по ценным бумагам и биржам (SEC) ведет учет каждой компании в Соединенных Штатах. Компании, чьи активы превышают 100 миллионов долларов США, должны подать специальный тип формы: форма 13F. Эта форма, поданная ежеквартально, раскрывает активы Filer, обеспечивая прозрачность в их инвестиционную деятельность и позволяя общественности и другим участникам рынка контролировать их.
Проблема, однако, заключается в том, что эти активы часто бывают громоздкими для доступа, и ценный анализ часто скрывается за платной игрой. Через Wallstreetlocal , файлы SEC 13F становятся более доступными и открытыми.
Этот репозиторий удерживает бэкэнд и фронт для Wallstreetlocal.
Чтобы посетить Wallstreetlocal, вы можете перейти на wallstreetlocal.com .
Вы также можете увидеть важные ресурсы, используемые для создания сайта на странице ресурсов, или просмотреть документацию OpenAPI на странице API.
Для получения дополнительной информации см. Документацию для стекла разработки WallstreetLocal ниже.
Производственная версия сайта размещена на wallstreetlocal.com , но также возможно самостоятельно.
Перейдите к папке Frontend.
cd frontendУстановить зависимости.
npm installРазвертывать.
npm run devИли для производственной сборки, запустите
npm run build
npm run start После выполнения вышеуказанных шагов, фронт должен быть размещен по адресу localhost:3000 , причем бэкэнд автоматически настроен на content.wallstreetlocal.com .
Хостинг только фронтаж является рекомендуемым способом самостоятельно, но если вы хотите самостоятельно самостоятельно самостоятельно, см. Ниже.
Чтобы запустить как разработку, так и производственные сборки, вам потребуются переменные среды для сторонних API. Большинство переменных среды в приведенных примерах, которые вы можете сохранить как есть, но для ключей API вам необходимо посетить следующие услуги.
Эти три различных сервиса позволяют получить самые современные и точные данные, а также избегают ограничения скорости.
Хотя рекомендуется отключить телеметрию для самостоятельного управления, вы можете включить телеметрию через переменную среды TELEMETRY .
Для телеметрии/отслеживания/журналов Wallstreetlocal использует Sentry. Вы можете зарегистрироваться здесь или самостоятельно.
Сборка разработки в основном создается для тестирования, поэтому она идеально подходит для самостоятельного ведения.
Чтобы запустить полное приложение, вам нужны микросервисы, работающие через Docker, и основное приложение, работающее отдельно.
Вы можете найти файл Development Compose здесь. Вам также понадобится файл .env , который можно найти здесь.
Как только у вас есть все файлы конфигурации, чтобы запустить приложение, запустите следующее.
Перейдите в справочный каталог.
cd backendЗапустите микросервисы, вызывая файл Development Compose.
docker compose -f docker-compose.dev.yaml up -dПримечание. Вы должны остановить эти микросервисы после того, как вы закончите их использовать (в противном случае они будут тратить ресурсы на неопределенный срок). Чтобы остановить их, запустите следующее.
docker compose -f docker-compose.dev.yaml down # Run after you've finished
Установите зависимости с ультрафиолетом.
PIPX Установка UV # больше опций по адресу 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
Производственная сборка создана для развертывания в масштабе, поэтому ее запуск будет более громоздким.
Вы можете найти файл Compose здесь. Нет файла .env , поскольку все переменные среды включены в файл Compose.
Если вы не запускаете производственную сборку для многих людей, вы должны изменить следующие настройки.
localhostКак только у вас есть все файлы конфигурации, чтобы запустить приложение, запустите следующее.
Перейдите в справочный каталог.
cd backendЗапустите все приложение с помощью одной команды.
docker compose -f docker-compose.prod.yaml upЕсли вы чувствуете, что можете внести свой вклад в этот проект, или вы нашли ошибку, создайте проблему или запрос на привлечение.
Этот проект поддерживается исключительно, поэтому он подвержен ошибкам и анти-паттернам, пожалуйста, позвоните им, где вы их видите. Все вклады высоко ценится!
MIT Лицензия
Нормы поведения
