Introdução geral
O Audibit é um projeto de código aberto cuja função principal é transformar automaticamente artigos populares de tecnologia, como Hacker News, TechCrunch etc., em podcasts de áudio, permitindo que os usuários ouçam as informações na Web ou no celular enquanto se deslocam, trabalham ou estão ocupados. O projeto usa Next.js e Reagir O Audibit suporta configuração zero para começar, com conteúdo atualizado regularmente via GitHub Action e implantado no Netlify. Os usuários podem personalizar os feeds de artigos, e a comunidade pode contribuir com código via GitHub. O projeto está licenciado sob a AGPL-3.0 para entusiastas e desenvolvedores de tecnologia.
Lista de funções
- Rastreie automaticamente artigos de tecnologia do Hacker News, TechCrunch, InfoQ, CoinDesk e muito mais.
- Transforme artigos em podcasts de áudio de alta qualidade usando as tecnologias OpenAI e Lemonfox.
- Fornecimento de aplicativos da Web (
https://audibit.app
), suporta escuta instantânea. - Suporte para aplicativos móveis React Native, compatíveis com iOS e Android.
- Os artigos e o áudio são atualizados diariamente por meio do GitHub Action, sem necessidade de esforço manual.
- Implemente com a Netlify para simplificar o processo de hospedagem.
- Código-fonte aberto, suporte para feeds de artigos personalizados e extensões de recursos.
- Use o Pinecone e o Firestore para gerenciar dados de artigos e índices de pesquisa.
Usando a Ajuda
Instalação e implementação
O Audibit é um projeto de código aberto baseado no GitHub e requer habilidades básicas de desenvolvimento para instalação e implantação. Aqui estão as etapas detalhadas:
- armazém de clones
Clone seu repositório Audibit localmente usando o Git:git clone https://github.com/YinTokey/Audibit.git cd Audibit
- Instalação de dependências
Certifique-se de que o Node.js esteja instalado e execute o seguinte comando para instalar as dependências do projeto:npm install
- Configuração de variáveis de ambiente
No diretório raiz do projeto, crie o arquivo.env
adicione o seguinte:OPENAI_API_KEY=[your_openai_key] GOOGLE_SERVICE_ACCOUNT=[your_service_account_string] PINECONE_API_KEY=[your_pinecone_key] DB_NAME=Audibit
OPENAI_API_KEY
: do site oficial da OpenAI para conversão de texto em fala.GOOGLE_SERVICE_ACCOUNT
Para o banco de dados Firestore, consulte a documentação do projetogoogle_service.md
Gerar.PINECONE_API_KEY
Usado para indexação do Pinecone e precisa corresponder ao nome do banco de dados do Firestore (Audibit
).- Certifique-se de que o Firestore e o Pinecone tenham criado um novo arquivo chamado
Audibit
O banco de dados e o índice do
- operação local
Execute o servidor de desenvolvimento e visualize o projeto:npm run dev
entrevistas
http://localhost:3000
Visualize o aplicativo da Web. - Construção e execução da produção
Crie a versão de produção e inicie o serviço:npm run build npm run start
- Configuração de tarefas temporizadas
O Audibit usa o GitHub Action para rastrear artigos automaticamente. Editar.github/workflows/cron_job.yml
Defina o tempo de captura diário; para obter uma descrição detalhada, consultecron_job.md
. - Implementação na Netlify
- Faça login na Netlify e crie um novo site.
- Conecte-se ao seu repositório do GitHub e selecione o projeto Audibit.
- Defina o comando de compilação como
npm run build
O catálogo de lançamentos é.next
. - Quando a implantação estiver concluída, consulte a seção
deployment.md
Configuração otimizada. - Os locais de implantação estão disponíveis por meio do
https://audibit.app
Acesso.
- aplicativo móvel
A Audibit oferece aplicativos móveis React Native, endereço de repositório:git clone https://github.com/YinTokey/audibit-mobile.git
- Instale o ambiente React Native e execute
npm install
. - Inicie o aplicativo:
npx react-native run-android npx react-native run-ios
- O aplicativo se conecta à API implementada pela Netlify para obter conteúdo de áudio.
- Instale o ambiente React Native e execute
Operação das principais funções
Ouvir podcasts de áudio
- entrevistas
https://audibit.app
Ou abra o aplicativo móvel. - A página inicial apresenta listas de áudio dos artigos de tecnologia mais recentes de fontes como Hacker News, TechCrunch e outras.
- Clique no título do artigo para reproduzir o áudio, com suporte para pausa, avanço rápido, retrocesso e download.
- O Mobile suporta reprodução em segundo plano para cenários de deslocamento para o trabalho ou de condicionamento físico.
- O lado da Web usa o Chakra UI para fornecer uma interface limpa e um design responsivo para se adaptar a diferentes dispositivos.
Feed de artigos personalizado
- compilador
config/feeds.js
A primeira é adicionar novos feeds RSS, como:feeds: [ { name: 'Hacker News', url: 'https://news.ycombinator.com/rss' }, { name: 'TechCrunch', url: 'https://techcrunch.com/feed/' }, { name: 'Custom Feed', url: '[your_rss_url]' } ]
- Depois de fazer o commit das alterações, execute o GitHub Action para atualizar o conteúdo de áudio.
Pesquisa e gerenciamento de dados
- O Pinecone oferece função de pesquisa de artigos e suporte móvel para pesquisa de palavras-chave.
- Visualize os metadados do artigo no console do Firestore, que podem ser excluídos ou editados manualmente.
- Verifique regularmente o banco de dados para garantir a sincronização dos dados e a integridade do índice.
advertência
- Proteja as chaves de API contra vazamentos para repositórios públicos.
- Os pacotes gratuitos da Netlify têm limitações de tráfego e precisam ser atualizados para uso em alta frequência.
- O aplicativo móvel deve ser compatível com os sistemas iOS e Android mais recentes.
- A contribuição de código requer um Pull Request, seguindo as diretrizes de contribuição do projeto.
- O projeto usa a licença AGPL-3.0, e as alterações no código precisam ser de código aberto.
Operação da função em destaque
Início rápido com configuração zero
- Os usuários não precisam de configurações complexas para acessar
https://audibit.app
Você pode ouvi-lo. - O GitHub Action atualiza seu conteúdo automaticamente, de modo que os usuários só precisam se concentrar na experiência auditiva.
Geração de áudio de alta qualidade
- Combinado com a tecnologia TTS da OpenAI e da Lemonfox, o áudio é claro e natural.
- Oferece suporte à conversão de artigos em vários idiomas para usuários internacionalizados.
Desenvolvimento orientado pela comunidade
- Os usuários podem enviar feedback sobre problemas, sugestões de recursos ou melhorias no código via GitHub.
- Foco nos desenvolvedores
@yintokey
de sua conta X para receber atualizações do projeto.
cenário do aplicativo
- Acesso a informações durante o trajeto
Os usuários ouvem os artigos mais recentes do TechCrunch no Audibit mobile enquanto estão no ônibus ou no metrô, fazendo uso eficiente do seu tempo. - Desenvolvedor Tecnologia Aprendizagem
Os programadores ouvem as discussões temáticas do Hacker News para saber mais sobre projetos de código aberto ou tendências de programação que inspiram o desenvolvimento. - Entrada de conhecimento durante o condicionamento físico
Os usuários ouvem os artigos técnicos do InfoQ em fones de ouvido enquanto correm ou se exercitam, para que possam se exercitar e aprender ao mesmo tempo. - Envolvimento da comunidade de código aberto
Os desenvolvedores aprendem técnicas modernas de desenvolvimento da Web otimizando o front-end Next.js da Audibit ou os aplicativos React Native.
QA
- Quais fontes de artigos são compatíveis com o Audibit?
Hacker News, TechCrunch, InfoQ, CoinDesk são suportados por padrão, com feeds RSS definidos pelo usuário. - Como faço para executar meu projeto localmente?
Clonagem de repositórios, instalação de dependências, configuração de.env
execute o arquivonpm run dev
. - Preciso pagar para fazer a implementação na Netlify?
Os pacotes gratuitos da Netlify oferecem suporte a implementações individuais, com taxas por exceder os limites de tráfego. - Como está a qualidade do áudio?
Usando a tecnologia TTS da OpenAI e da Lemonfox, o áudio é claro e suporta vários idiomas. - Como faço para contribuir com o código?
Envie um Pull Request no GitHub, consulte as Diretrizes de contribuição e receba feedback sobre problemas e sugestões de recursos.