Este projeto visa a criação de um template baseado em Feature-Based para um Aplicação Mobile Escalável que possa ser utilizado no momento de criação de projetos utilizando React Native, visto que o processo de instalação e configuração das libs no inĂcio de um projeto podem gerar certa complexidade e muitas vezes atĂ© erros que atrasam o processo, atrapalhando assim o fluxo de desenvolvimento.
Esse template foi baseado no no Template Rocketseat Basic da Rocketseat.
Abaixo segue o que foi utilizado na criação deste template:
- React Native - O React Native é um framework que permite o desenvolvimento de aplicações mobile usando Javascript e React;
- React Navigation - O React Navigation surgiu da necessidade comunidade do React Native de uma navegação de forma fácil de se usar, e escrita toda em Javascript;
- React Native Gesture Handler - API declarativa que permite a manipulação de toques e gestos no React Native;
- React Native Device Info - API que permite a acessar informações sobre o Device;
- Axios - O Axios Ă© um cliente HTTP baseado em Promises para Browser e NodeJS;
- Ramda - O Ramda seria Uma biblioteca funcional prática para programadores de JavaScript, que trabalha em cima de manipulação com Arrys e Objetos.
- Moment - O Moment seria uma biblioteca para Analise, validação, manipulação e exibição de datas e horas em JavaScript.
- Prop Types - Verificação de tipo em tempo de execução para propriedades (props) React e objetos semelhantes;
- Reactotron - O Reactotron Ă© um app Desktop para inspecionar projetos em React ou React Native. Está disponĂvel para macOS, Linux e Windows;
- reactotron-react-native - Plugin para configurar o Reactotron para se conectar ao projeto React Native;
- Babel - O Babel é um compilador JavaScript gratuito e de código aberto e transpiler configurável usado no desenvolvimento de aplicações Javascript;
- babel-eslint - Este pacote Ă© um wrapper do parser do Babel para o ESLint;
- babel-plugin-root-import - Esse plugin do Babel permite que sejam feitos imports e requires em caminhos baseados em uma raiz(root);
- babel-plugin-transform-remove-console - Esse plugin do Babel remove todos os console.* da sua aplicação (Dica no site oficial do RN);
- Eslint - O ESLint é uma ferramenta de lint plugável para JavaScript e JSX;
- eslint-config-airbnb - Este pacote fornece o .eslintrc do Airbnb como uma configuração compartilhada extensĂvel;
- eslint-plugin-import - Plugin do ESLint com regras para ajudar na validação de imports;
- eslint-plugin-jsx-a11y - Verificador estático AST das regras do a11y em elementos JSX;
- eslint-plugin-react - Regras de linting do ESLint especĂficas do React;
- eslint-plugin-react-native - Regras de linting do ESLint especĂficas do React Native;
- eslint-import-resolver-babel-plugin-root-import - Um resolver da lib babel-root-import para a lib eslint-plugin-import;
- eslint-plugin-prettier - Regras de linting do ESLint e algumas indicadas pelo prĂłprio Prettier;
- EditorConfig - O EditorConfig é um formatador de arquivos e coleções em forma de Plugin para Editores de código/texto com o objetivo de manter um padrão de código consistente entre diferentes editores, IDE's ou ambientes;
- Prettier - O Prettier é um formatador de código opinativo, que dá suporte a várias linguagens, como o JavaScript, por exemplo. Usamos ele principalmente para manter o código consistente.
- .prettierignore - Server para que arquivos especificados nesse arquivo, eles sejam ignorados pelo Prettier para fazer a formatação do código.
- .prettierrc.json - Server para adicionar nele as regras do Prettier no seu projeto, de forma que qualquer pessoas que usar seu projeto, irá ter as mesmas regras que você.
Para conseguir utilizar o template, seja através do React Native CLI ou com uma cópia local dos arquivos, siga os passos abaixo.
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)
A estrutura de arquivos está da seguinte maneira:
.
├── src/
│ ├── assets/
│ │ └── images/
│ │ └── react.png
│ ├── common/
│ │ ├── components/
│ │ │ ├── Button/
│ │ │ │ └── index.js
│ │ └── utils/
│ │ ├── dateFormatting.js
│ │ └── index.js
│ ├── config/
│ │ └── ReactotronConfig.js
│ ├── modules/
│ │ ├── user/
│ │ │ ├── components/
│ │ │ │ └── Card/
│ │ │ │ └── index.js
│ │ │ └── screens/
│ │ │ └── UserScreen
│ │ │ └── index.js
│ │ ├── api.js
│ │ ├── constants.js
│ │ └── util.js
│ ├── navigation/
│ │ └── index.js
│ ├── themes/
│ │ ├──colors.js
│ │ ├──fonts.js
│ │ ├──images.js
│ │ ├── index.js
│ │ └── metrics.js
│ └── index.js
├── .editorconfig
├── .eslintrc.json
├── .prettier.json
├── .prettierignore
├── .gitignore
├── babel.config.js
├── dependencies.json
├── devDependencies.json
├── index.js
├── jsconfig.js
├── package.json
└── README.md
Serão explicados os arquivos e diretórios na seção de Edição.
- Para instalar e utilizar esse template o processo Ă© bem simples, basta criar um projeto novo utilizando o comando:
react-native init AwesomeExample --template feature-based-basic
- Depois do projeto criado vocĂŞ pode deletar o arquivo
App.js
(executando esse comando na raiz do projeto:rm ./App.js
) da raiz, pois o arquivoindex.js
agora aponta para a pasta src.
Com isso o projeto será criado com todas as dependências do template devidamente instaladas e linkadas, tal como os arquivos de configuração que são copiados para o projeto.
Para que os gestos sejam habilitados no Android é necessário um passo a mais, que é bem simples, abra o arquivo android/app/src/main/java/<pacote_do_projeto>/MainActivity.java
, e começe importando os pacotes como abaixo:
// ...
import com.facebook.react.ReactActivity;
// Importações adicionadas
import com.facebook.react.ReactActivityDelegate;
import com.facebook.react.ReactRootView;
import com.swmansion.gesturehandler.react.RNGestureHandlerEnabledRootView;
Feito a importação vamos criar um método novo, logo abaixo do getMainComponentName()
, ficando:
public class MainActivity extends ReactActivity {
@Override
protected String getMainComponentName() { ... }
// MĂ©todo adicionado
@Override
protected ReactActivityDelegate createReactActivityDelegate() {
return new ReactActivityDelegate(this, getMainComponentName()) {
@Override
protected ReactRootView createRootView() {
return new RNGestureHandlerEnabledRootView(MainActivity.this);
}
};
}
}
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;-
assets - DiretĂłrio para guardar todo tipo de arquivo, relacionado a assets (Ex: images, fonts, etc..)
- images - DiretĂłrio para guardar todo tipo de imagem.
-
common - Diretório para guardar todo tipo arquivo que seja genérico, ou seja, arquivos que sejam usados em mais de uma feature.
-
components - Diretório para guardar components que sejam genéricos, ou seja, components que sejam usados em mais de uma feature.
-
Button - DiretĂłrio exemplo de um component.
- index.js - Arquivo onde será feita toda lógica do component.
-
utils - DiretĂłrio para guardar arquivos que contenham lĂłgicas e nĂŁo sejam screens ou components (Exemplo, dateFormatting.js).
- dateFormatting.js - Arquivo que teria a lógica de formatação de data, sendo ele um util.
-
-
-
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;
modules - DiretĂłrio que armazenas todas as features do app.
-
user - DiretĂłrio para guardar todo ou qualquer arquivo (screens, components, utils, etc.) relacionado a feature user
-
components - DiretĂłrio para guardar components relacionados APENAS a feature de user.
-
Card - DiretĂłrio exemplo de um component.
- index.js - Arquivo onde será feita toda lógica do component.
-
-
screens - DiretĂłrio para guardar arquivos de telas relacionados APENAS a feature de user.
-
UserScreen - DiretĂłrio exemplo de uma tela.
- index.js - Arquivo onde será feita toda lógica do component.
-
-
api.js - Arquivo que contem a comunicação com a API de User, no caso os EndPoints.
-
constants.js - Arquivo que contem constants relacionados APENAS a feature de user.
-
util.js - Arquivo que contem lĂłgicas/utils relacionados APENAS a feature de user.
-
navigation - Diretório para guardar o arquivo responsável pela navegação da aplicação.
- index.js - Arquivo com as configurações de navegação da aplicação, nele são criados os Navigator disponibilizados na biblitoeca React Navigation;
themes - Diretório onde para guardar todos os arquivos relacionados a estilização de modo global.
-
colors.js - Arquivo com as constantes das cores a serem usadas na aplicação.
-
fonts.js - Arquivo com as fonts e seus styles a serem usados na aplicação.
-
images.js - Arquivo com as constantes das images a serem usadas na aplicação.
-
index.js - Arquivo com todos os arquivos dessa pasta indexado.
-
metrics.js - Arquivo com as metricas tratadas para vários tipos de devices a partir do seu PixelRatio.
-
-
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óriosrc
;
.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__
;
.prettier.json - Arquivo de configuração do Prettier, é nele que são inseridas as regras e configurações.
.prettierignore - Arquivo de ignore do Prettier, Ă© nele que sĂŁo inseridas os arquivos onde nĂŁo queremos que o prettier atue.
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.
Para publicar um template como esse o processo bastante simples e rápido.
-
Crie uma conta no site do NPM;
-
Com a conta criada execute o comando abaixo e insira suas credenciais;
npm login
-
Basta abrir o arquivo
package.json
e modificar as informações de acordo com o seu template, mas as informações mais importantes são duas, oname
e oversion
, que são os únicos que tem restrições, seguem abaixo as restrições:- O
name
sempre deve começar com o prefixoreact-native-template-
seguido do nome do seu template; - O template deve ser publicado em uma conta pessoal, pois quando publicado em uma Organization Ă© acrescentado o prefixo
@<nome_da_organization>
no nome do pacote; - O
name
deve ser único, não podendo ser igual ao de um template já publicado; - A
version
deve ser atualizada a cada publicação, se o template está na versão 0.0.1 e é preciso publicar uma atualização no mesmo, aversion
deve ser diferente e superior a versĂŁo atual, por exemplo, 0.0.2;
- O
-
ApĂłs configurar corretamente o
package.json
basta executar no terminal/prompt o comandonpm publish
; -
Com a publicação finalizada o template deve ficar disponĂvel atravĂ©s do link
https://www.npmjs.com/package/react-native-template-<nome_do_template>
.
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.
- Faça um Fork do projeto
- Crie uma Branch para sua Feature (
git checkout -b feature/FeatureIncrivel
) - Adicione suas mudanças (
git add .
) - Comite suas mudanças (
git commit -m 'Adicionando uma Feature incrĂvel!
) - Faça o Push da Branch (
git push origin feature/FeatureIncrivel
) - Abra uma Pull Request
Me segue lá no Twitter: @samuelmataraso