💻 Sobre o projeto

Este é um repositório para estrutura de pastas e configurações iniciais para projetos em NodeJs com TypeScript

🛠 Tecnologias

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

• Node.js
• TypeScript
• Express
• Babel
• Jest

🚀 Como executar o projeto

Pré-requisitos

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

🎲 Rodando o Back End em desenvolvimento

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

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

# 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 o Back End em produção

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

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

# Instale as dependências
$ yarn

# Execute o comando para gerar a build
$ yarn build

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

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

😯 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!