Neste repositório será gerenciado o desenvolvimento da aplicação móvel do sistema CNotes. Aqui serão armazenado o código, documentação e afins durante todo o desenvolvimento da aplicação.

Essa é uma aplicação desenvolvida por meio do React-Native. Sendo inicialmente gerada pelo expo init.

Para construir, executar e testar o projeto é necessário que as etapas a seguir sejam executadas (dentro da pasta app/):

1. Verificar que o ambiente de desenvolvimento (Expo Quickstart) está configurado
   1. Node.js 12
   2. Yarn
   3. Expo
   4. Simulador instalado ou o app do Expo instalado em um dispositivo
2. Criar um arquivo .env de configurações baseando-se no arquivo .env.example
3. Instalar as dependências do projeto, executando yarn (dentro da pasta app/)
4. Executar a aplicação usando yarn start ou yarn run ios/android

Feito isso, o projeto estará, idealmente, funcionando.

O projeto deve ser documentado no diretório docs do repositório, em formato Markdown. Lá estarão documentações diversas, desde problemas frequentes até detalhamentos do funcionamento da aplicação e telas.

Documentações dentro do código não devem ser substituídas por essas.

Para colaborar na aplicação será necessário seguir os seguintes requisitos:

É necessário conhecimento básico sobre o funcionamento do Git e como utilizá-lo. Além disso, o uso de boas práticas de Git é necessário, dentre elas ressalta-se:

1. Commits frequentes e sucintos
2. Uso de branches para qualquer mudança na aplicação
3. Evitar rebases e force pushes

É recomendado o uso do Prettier para formatação dos códigos. Alguns editores e IDEs possuem extensões para realizar essa formatação de maneira automática: guia para integração do Prettier com seu editor

• VSCode - Prettier
• WebStorm - Prettier
• Atom - Prettier
• ViM - Prettier

Além do Prettier, será usado o ESLint para garantir a qualidade do código da aplicação. A fazer

Todo código a ser adicionado na aplicação deve ser antes revisado por ume colega de equipe, a fim de evitar entrada de código defeituoso na aplicação, a colaboração de todos nesse processo de revisão é extremamente importante. Para realizar essa revisão é necessário que toda feature que venha a ser adiciona esteja em uma branch a parte (de preferência com um nome descritivo como: feature/login, fix/validacaoEmail), que então será mesclada à branch de desenvolvimento por meio de uma Pull Request, onde o código será validado e revisado antes de ser enviado.

Guia: Code-review

A estrutura do projeto está descrita em structure