Pioneiras

Tabela de Conteúdo

• Tabela de Conteúdo
• Sobre o Projeto
  • Projeto
    • Objetivo
    • Foco
• Começando
  • Pré-requisitos
  • Estrutura de Arquivos
  • Instalação
    • Passo Adicional no Android
  • Edição
  • Publicação
• Contribuição
• Licença
• Contato

Sobre o Projeto

Projeto

Objetivo

Valorizar o pioneirismo das mulheres que um dia foram apagadas da historia brasileira e mundial,mas também promover inspiração para o nascimento de mais meninas e mulheres pioneiras em nossa sociedade.

Foco

Temos como foco principal a divulgação da história destas mulheres com o desenvolvimento de um aplicativo educativo que possa ser usado - não somente nas escolas, por alunos e professores - mas por toda sociedade, independente de idade ou quaisquer outros estereótipos.

Começando

Para conseguir executar o projeto é necessário alguns peqiuenos passos!

Pré-requisitos

Antes de seguirmos para as configurações e uso do template, é ideal que você tenha o ambiente configurado para criar e testar aplicativos em React Native, para isso você pode seguir o guia do link abaixo:

Ambiente React Native (Android/iOS)

Estrutura de Arquivos

A estrutura de arquivos está da seguinte maneira:

Serão explicados os arquivos e diretórios na seção de Edição.

Instalação

1. Para instalar e utilizar esse projeto o processo é bem simples, basta clonar um projeto utilizando o comando:

git clone 'esta url'

2. Depois do projeto clonado é necessário rodar o seguinte comando para instalar as dependencias:

yarn 

3. Com as bibliotecas instaladas, de modo a executar o aplicativo, é necessário conectar um emulador android ou um telefone celular que permita testes do aplicativo e rodar os seguintes comandos: a. sh yarn start --reset-cache Em outra janela aberta no projeto, execute: b. sh yarn android ��

Edição

Nesta seção haverão instruções caso você queira editar o template, explicando para que os diretórios são utilizadas e também os arquivos de configuração.

• src - Diretório contendo todos os arquivos da aplicação, é criado um diretório src para que o código da aplicação possa ser isolado em um diretório e facilmente portado para outros projetos, se necessário;

  • config - Diretório para guardar os arquivos de configuração da aplicação, por exemplo, a configuração de uso do Reactotron e configuração de inicialização do Firebase;

    • ReactotronConfig.js - Arquivo contendo a configuração do Reactotron para ser usado na aplicação;

  • images - Diretório para armazenar imagens em geral que possam ser utilizadas na aplicação, esse diretório pode ser renomeado para assets e dentro de assets criar um novo diretório para guardar somente as imagens, assim é possível ter um diretório para guardar todo tipo de arquivo, e não apenas imagens;

  • pages - Diretório onde ficam as páginas (telas) da aplicação, como forma de padronização e boas práticas toda página fica dentro de um diretório com seu nome;

    • Main - Diretório exemplo de uma página cujo nome é Main, por padrão foi adotado usar sempre como nome do diretório o nome da página em camelCase, dentro desse diretório é necessária a criação ao menos do arquivo index.js;

      • index.js - Arquivo com toda a lógica da página, tal como os componentes visuais a serem renderizados;

  • services - Diretório onde serão criados os arquivos relacionados a serviços utilizados na aplicação, por exemplo, requisições HTTP, autenticação com Firebase ou qualquer outro serviço que for utilizado;

    • api.js - Arquivo com a configuração da biblioteca Axios para envio de requisições HTTP, o endereço que vem configurado por padrão é para a API do Github;

  • index.js - Arquivo responsável por centralizar o código do diretório src, nele são chamadas as rotas tal como qualquer outra configuração que precise ser executada na inicialização da aplicação, ele é como um Entry Point do diretório src;

  • routes.js - Arquivo com as configurações de navegação da aplicação, nele são criados os Navigator disponibilizados na biblitoeca React Navigation;

• .editorconfig - Arquivo destinado à configuração do Plugin Editor Config, que padroniza algumas configurações para o editor em diferentes ambientes;

• .eslintrc.json - Arquivo de configuração do ESLint, é nele que são inseridas as regras e configurações de Linting do projeto, tal como a configuração do Resolver para o Babel Plugin Root Import e configuração da variável global __DEV__;

• babel.config.js - Arquivo de configuração do Babel, é nele que é configurado o Babel Plugin Root Import para aceitar imports absolutos na aplicação usando o diretório src como raiz;

• dependencies.json - Arquivo contendo apenas um objeto com a lista de dependências que devem ser instaladas na aplicação, vale lembrar que as dependências que já vem por padrão no projeto como react e react-native não precisam estar nessa lista, a menos que você queira gerenciar a versão dessas libs;

• devDependencies.json - Arquivo contendo apenas um objeto com a lista de dependências de desenvolvimento que devem ser instaladas na aplicação, vale lembrar que as dependências de desenvolvimento que já vem por padrão no projeto como @babel/core, eslint, entre outras, não precisam estar nessa lista, a menos que você queira gerenciar a versão dessas libs;

• index.js - Arquivo raiz da aplicação, também chamado de Entry Point, é o primeiro arquivo chamado no momento do build e execução da aplicação, nele é chamado o arquivo src/index.js que por sua vez chama as rotas da aplicação;

• jsconfig.json - Arquivo de configuração do Javascript no Editor, ele é o responsável por ativar o Auto Complete de códigos Javascript na aplicação;

• package.json - Diferente dos projetos comuns, esse arquivo tem as configurações necessárias para a publicação do Template no NPM, para saber mais sobre isso veja a seção abaixo.

Contribuição

Contribuições são o que fazem a comunidade open source um lugar incrível para aprender, inspirar e criar. Qualquer contribuição que você fizer será muito apreciada.

1. Faça um Fork do projeto
2. Crie uma Branch para sua Feature (git checkout -b feature/FeatureIncrivel)
3. Adicione suas mudanças (git add .)
4. Comite suas mudanças (git commit -m 'Adicionando uma Feature incrível!)
5. Faça o Push da Branch (git push origin feature/FeatureIncrivel)
6. Abra uma Pull Request