LetsTN/curso-Node-API

Repositório contendo o código desenvolvido durante o curso de Node.js do zero a produção, por Waldemar Neto Dev Lab (disponível em https://www.nodejs-typescript-api.com/curso-gratis/)

Node.js API com Typescript

Uma API para ver como está o tempo para surfar 🌊🏄

Índice

• Sobre o Projeto
• Como rodar o projeto
• Uso
• Roadmap
• Contribua
• Autores

Sobre o Projeto

API desenvolvida durante o curso de Node.js do zero a produção, por Waldemar Neto Dev Lab (disponível em link).

Durante o curso é criado uma API para calcular a melhor condição de surf entre varias praias, essa API tem como objetivo servir a aplicação web.

A aplicação web não é construida durante o curso pois ela não é o foco do conteúdo, mas ela é disponibilizada pronta (procure no repositório do curso por web). No momento estou trabalhando em montar uma aplicação web em Angular para consumir esta API (para aprender Angular também 😜).

As (principais) tecnologias usadas nesse projeto foram:

• Node.js
• Typescript
• Jest
• MongoDB
• Github Actions

Como rodar o projeto?

Essas instruções mostam como ter uma cópia do projeto instalada e funcionando em sua máquina local para fins de desenvolvimento e teste.

Pré-requisitos

Antes de mais nada, você precisa ter instalado:

• Node.js

• npm

npm install npm@latest -g

• MongoDB (usando o docker)

Caso queira usar o ATLAS, vá em config > default.json e config > test.json e mude o mongoUrl para que você consiga se conectar ao seu cluster. (Getting started com o Atlas)

• Yarn

Instalação

Para instalar:

1. Clone o repositório

git clone https://github.com/LetsTN/curso-Node-API.git

2. Instale os pacotes

yarn install

Uso

Para saber mais, rode sua aplicação usando

yarn start:local

e vá até http://localhost:3000/docs/

Roadmap

Vá em open issues para uma lista de funcionalidades futuras (and issues).

Contribua

As contribuições são o que torna a comunidade de código aberto um lugar incrível para aprender, inspirar e criar. Quaisquer contribuições que você fizer serão muito apreciadas.

Caso queira contribuir, siga esses passos:

1. Dê um fork no projeto
2. Crie uma branch com sua contribuição (git checkout -b feature/suaFeature)
3. Dê um commit com suas mudanças (git commit -m 'Adicionando suaFeature')
4. Dê um push para sua branch (git push origin feature/suaFeature)
5. Abra uma pull request