Documentação para Desenvolvedores
A ChurchApps é uma coleção de aproximadamente 20 projetos de código aberto que, juntos, fornecem uma plataforma completa de gestão de igrejas. Os projetos abrangem APIs de backend, aplicações web, aplicativos móveis, uma aplicação para desktop e bibliotecas compartilhadas -- todos escritos em TypeScript. Esta seção oferece tudo o que você precisa para configurar um ambiente de desenvolvimento local e começar a contribuir.
Visão Geral da Arquitetura
Os projetos são repositórios independentes (não um monorepo). O código compartilhado é publicado no npm sob o escopo @churchapps/* e utilizado como dependências comuns. Isso significa que você pode trabalhar em um único projeto sem precisar clonar todo o ecossistema.
Principais características:
- Linguagem: TypeScript em todo o projeto
- Backend: APIs em Node.js / Express implantadas no AWS Lambda por meio do Serverless Framework
- Web: React 19 (Vite e Next.js), Material-UI 7
- Mobile: React Native com Expo
- Banco de dados: MySQL 8.0, um banco de dados por módulo de API
O Que Esta Seção Aborda
- Configuração -- Ambiente de desenvolvimento local, pré-requisitos e configuração
- Pré-requisitos -- Ferramentas e softwares necessários
- Visão Geral dos Projetos -- Todos os projetos em resumo
- Variáveis de Ambiente -- Como configurar os arquivos
.env
- API -- Configuração local da API principal, inicialização do banco de dados e estrutura dos módulos
- Aplicações Web -- Como executar o B1Admin, o B1App e o LessonsApp localmente
- Aplicativos Móveis -- Como criar o B1Checkin e outros aplicativos Expo
- Bibliotecas Compartilhadas -- Como trabalhar com Helpers, ApiHelper e AppHelper
- Implantação -- Como implantar APIs, aplicações web e aplicativos móveis
- Provedor de Conteúdo do FreePlay -- Como integrar a sua biblioteca de lições ao FreePlay
Comunidade e Recursos
| Recurso | Link |
|---|---|
| Organização no GitHub | github.com/ChurchApps |
| Rastreador de Problemas | Problemas do ChurchAppsSupport |
| Comunidade no Slack | Entrar no Slack |
A maneira mais rápida de começar a contribuir é escolher uma aplicação web (como o B1Admin), apontá-la para as APIs de demonstração compartilhadas e começar a fazer alterações no frontend. Não é necessário configurar banco de dados nem API.