ronitavares/monorepo-typescript-structure

Estrutura de pastas e configurações iniciais para projetos em monorepo utilizando NodeJs, React, React Native e Expo orientando a TDD com Jest

💻 Sobre o projeto

Este é um repositório monorepo com yarn workspaces, nele você vai encontrar toda a configuração inicial para o seu projeto com NodeJS, ReactJS, React Native e Expo em TypeScript, além disso toda a parte de eslint e prettier também já estão configuradas.

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

• Node.js
• React
• React Native
• Expo
• TypeScript
• Yarn Workspaces
• Eslint
• Prettier

🚀 Como executar o projeto

Podemos considerar este projeto como sendo divido em quatro partes:

1. Back End (pasta packages/server)
2. Front End (pasta packages/web)
3. Mobile com React Native CLI (pasta packages/mobile)
4. Mobile com Expo (pasta packages/app-expo)

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js, Yarn, Ambiente React Native. Além disto é bom ter um editor para trabalhar com o código como VSCode

🎲 Rodando o Back End (servidor)

# Clone este repositório
$ git clone https://github.com/pedroksty/monorepo-typescript-structure.git

# Acesse a pasta do projeto no terminal/cmd
$ cd monorepo-typescript-structure

# Vá para a pasta server
$ cd packages/server

# Instale as dependências
$ yarn

# Execute a aplicação em modo de desenvolvimento
$ yarn dev

# O servidor inciará na porta:4444 - acesse http://localhost:4444

🧭 Rodando a aplicação web (Front End)

# Clone este repositório
$ git clone https://github.com/pedroksty/monorepo-typescript-structure.git

# Acesse a pasta do projeto no seu terminal/cmd
$ cd monorepo-typescript-structure

# Vá para a pasta da aplicação Front End
$ cd packages/web

# Instale as dependências
$ yarn

# Execute a aplicação em modo de desenvolvimento
$ yarn start

# A aplicação será aberta na porta:3000 - acesse http://localhost:3000

📱Rodando a aplicação mobile com React Native Cli

# Clone este repositório
$ git clone https://github.com/pedroksty/monorepo-typescript-structure.git

# Acesse a pasta do projeto no seu terminal/cmd
$ cd monorepo-typescript-structure

# Vá para a pasta da aplicação Front End
$ cd packages/mobile

# Instale as dependências
$ yarn

# Execute a esse código no terminal
$ yarn start

# Execute a esse código em outro terminal porém no mesmo caminho
$ yarn android

# Escanei o QR CODE com o aplicativo Expo instalado no seu Smarthphone

📱Rodando a aplicação mobile com Expo

# Clone este repositório
$ git clone https://github.com/pedroksty/monorepo-typescript-structure.git

# Acesse a pasta do projeto no seu terminal/cmd
$ cd monorepo-typescript-structure

# Vá para a pasta da aplicação Front End
$ cd packages/app-expo

# Instale as dependências
$ yarn

# Execute a esse código no terminal
$ yarn start

# Escanei o QR CODE com o aplicativo Expo instalado no seu Smarthphone

😯 Como contribuir para o projeto

1. Faça um fork do projeto.
2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature

   Caso tenha alguma dúvida confira este guia de como contribuir no GitHub

📝 Licença

Este projeto esta sobe a licença MIT.

Feito com ❤️ por Pedro henrique 👋🏽 Entre em contato!