2.0.0 • Published 2 years ago

react-native-template-expo-darknlight v2.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
2 years ago

:rocket: Tecnologias usadas

Esse projeto contém as seguintes tecnologias:

💻 Projeto

Este projeto visa a criação de um template que possa ser utilizado no momento de criação de projetos utilizando React Native e o Expo, já com a implementação do Dark Mode e Light Mode nativo do aparelho.

⚙ Como rodar este projeto

Pré-requisitos

Para conseguir utilizar o template, seja através do Expo CLI ou com uma cópia local dos arquivos, siga os passos abaixo.

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:

Expo

E também será preciso um editor, eu indico o VSCode

🧭 Instalando

Para instalar e utilizar esse template o processo é bem simples, basta criar um projeto novo utilizando o comando:

$ expo init --template react-native-template-expo-darknlight

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.

📁 Estrtura de Arquivos

expo-darknlight
├── assets/
├── src/
│   ├── @types/
│   │   └── styled.d.ts
│   ├── pages/
│   │   └── Home/
│   │       └── index.tsx
│   │       └── styles.ts
│   ├── themes/
│   │   └── index.ts
│   │   └── dark.ts
│   │   └── light.ts
│   ├── index.tsx
│   ├── routes.js
├── .gitignore
├── babel.config.js
├── App.tsx
├── app.json
├── tsconfig.json
├── package.json

🗂 Edição

Nesta seção haverão instruções caso você queira editar o template, explicando para que os diretórios são utilizados 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;
  • @types - Diretório para armazenar types que o compilador não reconhece nas bibliotecas.

  • 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;

    • Home - Diretório exemplo de uma página cujo nome é Home, 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.tsx;

      • index.tsx - Arquivo com toda a lógica da página, tal como os componentes visuais a serem renderizados;
      • styles.ts - Arquivo com toda a estilização da página a serem renderizados;
  • routes.tsx - Arquivo com as configurações de navegação da aplicação, nele são criados os Navigators disponibilizados na biblioteca React Navigation;

  • App.tsx - 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/routes.tsx que por sua vez chama as rotas da aplicação;

  • tsconfig.json - Arquivo de configuração do TypeScript no Editor, ele é o responsável por ativar o Auto Complete de códigos TypeScript 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.

🔄 Notas de Atualização

  • 1.0.0
    • Versão Inicial do Projeto.
  • 1.0.2
    • Removido algumas pastas.
  • 1.0.3
    • Adicionado ESLint, Prettier e EditorConfig.
    • Padronização dos códigos.
  • 1.0.4
    • Correção de erros e bugs.
  • 1.0.5
    • Correção de erros e bugs.

:recycle: Como contribuir

  • Fork esse repositório;
  • Crie uma branch com a sua feature: git checkout -b my-feature
  • Commit suas mudanças: git commit -m 'feat: My new feature'
  • Push a sua branch: git push origin my-feature

Depois que o merge da sua pull request for feito, você pode deletar a sua branch.

:memo: Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

📱 Social

Me acompanhe nas minhas redes sociais.


Feito com ❤️ by Alexander 🤙🏾