Skip to content

Latest commit

 

History

History
102 lines (75 loc) · 4.57 KB

README.md

File metadata and controls

102 lines (75 loc) · 4.57 KB
Raw

Memento Studio

Sobre • Tecnologias Utilizadas • Instalação e Uso • Demonstração • Documentação • Autores • Contribuindo

Memento Studio (“Lembre-se de Estudar” em latim) é um aplicativo de flash cards que visa auxiliar estudantes em suas jornadas de estudo. A ideia é que o aplicativo permita que os usuários criem/busquem baralhos e possam utilizá-los para treinar/reforçar suas memórias acerca de um conteúdo alvo. De posse de um baralho, qualquer usuário retentor de uma conta em nossa plataforma poderá compartilhar sua criação com outros usuários (cadastrados ou não).

Principais tecnologias utilizadas

Servidor

Mobile

Instalação e uso

Servidor:

É necessário ter docker e docker-compose instalados em seu computador. Para construir a imagem do servidor, execute o seguinte comando.

cd server ; docker-compose build; cd ..

Para executar o servidor na porta 8080 execute:

cd server ; docker-compose up; cd ..

Caso queira utilizar o aplicativo no emulador não precisa configurar nada muito especifico, mas caso queira usar o aplicativo em seu dispositivo, então é necessário expor a porta 8080 para internet de maneira segura. Recomendamos a utilização do ngrok, que pode ser instalado seguindo os passos desse link. Depois de instalar o ngrok, vá para a pasta onde o executável está e execute:

./ngrok http 8080

Você verá algo parecido com a imagem abaixo.

image

Uma url será gerada, copie-a e substitua o valor da variável baseUrl em app/lib/src/utils/constants.dart. No meu caso, a url gerada foi https://bf68-2804-56c-a4d0-d000-1daf-e3e5-927b-af6b.sa.ngrok.io.

Mobile:

Para executar o aplicativo é necessário que você tenha o Android Studio e Flutter instalados e configurados. Além disso, caso queira realizar login no app também deverá configurar o Firebase, Facebook e o Google, esses dois ultimos somente caso queira realizar login com a plataforma.

Depois de configurar o necessário, basta ter um smartphone conectado ao computador e executar o seguinte comando.

cd app ; flutter run; cd ..

Demonstração

Video de demonstração do Memento Studio

Documentação

Para visualizar a documentação do backend, feita com Godoc, execute o comando:

godoc -http=:6060 --goroot $PWD/server

E abra o navegador em localhost:6060/pkg.

Para gerar e visualizar a documentação do frontend, feita com Dartdoc, execute os comandos:

cd app
dart doc . # gera a documentação
dart pub global activate dhttpd
dhttpd --path doc/api -p 7070

E abra o navegador em localhost:7070

Autores

Hericles Bruno Koelher – @hericles-koelher – [email protected]

Mikaella Ferreira – @mikaellafs – [email protected]

Contribuindo

  1. Faça o fork do projeto (https://github.com/yourname/yourproject/fork)
  2. Crie uma branch para sua modificação (git checkout -b feature/fooBar)
  3. Faça o commit (git commit -am 'Add some fooBar')
  4. Push (git push origin feature/fooBar)
  5. Crie um novo Pull Request