Inglês | Português
Monorepo do Memo.
Memo é um software de código aberto (escrito em Flutter) de repetição espaçada (SRS, em inglês) voltado ao tema de programação.
Atualmente, este projeto está construído apenas para gerar builds para Android e iOS. Embora o fato de que, dado a estabilidade da SDK do Flutter para desktop (Windows, Linux e macOS) e web, existe uma alta probabilidade que este projeto eventualmente suportará builds para todas as plataformas.
Este README e todos os sub-documentos presentes aqui (CONTRIBUTING, ARCHITECTURE & CHANGELOG) tem como objetivo guiar a estrutura deste projeto e devem auxiliar na escalabilidade das funcionalidades existentes hoje e nas que serão criadas com o decorrer do andamento do projeto. Estes documentos servem como um conjunto flexível de regras que guiam as decisões tomadas no andamento do projeto. Embora estas regras possam - e provavelmente irão - mudar, discussões devem ser levantadas sobre os motivos para tais mudanças, de maneira que essas discussões e decisões sejam transparentes para todos.
- Setup: como configurar seu projeto localmente;
- Arquitetura: como está estruturada a arquitetura da aplicação;
- Background: um pouco do background sobre este projeto;
- Contribuição & Boas Práticas: recomendações sobre contribuições;
- Licença: como essa aplicação está licenciada e como você pode utilizá-la.
Se você não tem ideia de como instalar o Flutter e rodá-lo localmente, dê uma olhada nesse Get started (em inglês)
Agora, se você já tem o Flutter configurado localmente, na pasta raíz do projeto, instale as dependências através do
comando flutter pub get.
O Memo possui dependências do Firebase que necessitam ser configuradas antes de rodar localmente. Mais informações sobre isso em ARCHITECTURE#firebase.
Como essa aplicação foi estruturada e como ela interage com dependência externas - escrito em detalhes em ARCHITECTURE (em inglês).
Se você está interessado em dar uma olhadinha sobre como acabamos lidando com o processo de software deste projeto (dentro da nossa equipe), dê uma olhada no .process/.
Veja o documento CONTRIBUTING para mais detalhes sobre como contribuir com este projeto.
Memo está licenciado sobre a licença BSD 3-Clause.
Este projeto foi construído com a ajuda dos patrocinadores abaixo:
- Maratona Discover: Aprenda programação na prática. E de graça.
- Startup Life Podcast: O seu podcast sobre negócios, tecnologia e inovação.
- Pingback: Crie conteúdo com total liberdade.