Application developed with offline-first and watermelon-db methodology

by React Native Example

Primeira versão do MEI Spot desenvolvido com a metodologia Offline-First e utiliza as tecnologias Typescript e React Native.

? Tecnologias

Mobile (React Native + TypeScript)

? COMO UTILIZAR

Primeiro, você precisa ter o NodeJS instalado na sua máquina.

Se você estiver utilizando o Linux, você pode optar por instalar o Node através do gerênciador de versões nvm para facilitar o processo de mudança da versão do Node, quando for necessário.

Você pode optar também por utilizar o yarn no lugar do npm. Você pode instalar clicando neste link.

Após ter o Node instalado, instale as dependências do React Native instale as dependências contidas nos arquivos package.json que se encontram na raíz do repositório (para o gerenciamento de commits), no diretório do app. Para instalar as dependências, basta abrir o terminal no diretório e digitar o comando:

$ yarn
ou
$ npm install

Você precisará criar um arquivo na raíz do projeto chamado .env com a chave de requisição da API do servidor Backend.

Dentro do arquivo coloque o URL de seu servidor, em ambiente de desenvolvimento utilize o endereço local da sua máquina:

# exemplo
API_URL="http://192.168.1.22:5000/"

Após ter instalado todas as dependências e criado o arquivo com a chave de requisição, você poderá gerar a build do app para o seu dispositivo com:

$ yarn android

** ? Troubleshoots**

Cannot read properties of undefined (reading ‘transformFile’) at Bundler.transformFile

Ran into the same issue with Node.js 17.0.0. To solve it, I downgraded to version 14.18.1, deleted node_modules and reinstalled.

COMO CONTRIBUIR

  • Verifique as Issues que estão abertas e se já não existe alguma com a sua feature;
  • Abra uma Issue com o nome e descrição da sua feature e assine com o seu usuário informando que irá fazê-la;
  • Faça um fork do repositório;
  • Entre no sua página do GitHub e faça um clone do seu fork;
  • Crie uma branch com o nome da sua feature: git chechout -b feat/minhaFeature;
  • Faça as alterações necessárias no código ou na documentação;
  • Instale as dependências do commitlint na raíz do projeto para a verificação dos commits: npm install ou yarn;
  • Faça o commit das suas alterações seguindo as convenções de commit, adicione na descrição o id da sua Issue em parênteses e lembre de fechar a sua Issue com o id no rodapé do commit:

  <tipo>(escopo opcional): <descrição> (#x)

  [corpo do commit]

  Close #x

Exemplo:

  feat: adicionado componente para tal coisa (#52)

  Foi adicionado um componente para tal coisa com o objetivo de melhorar tal coisa, deixando o projeto de tal maneira.

  Close #52
  • Faça um push para a sua branch: git push origin feat/minhaFeature;
  • Agora é só abrir um pull request no repositório que você fez o fork e assim que acontecer o merge sua Issue será fechada e suas alterações irão fazer parte do projeto;
  • Depois que o merge da sua pull request for feito, você pode deletar a sua branch.

* Obrigado por contribuir! ❤️ ? ?

GitHub

View Github