AirelRibeiro / talker-manager

Projeto com construção de uma API com CRUD (Create, Read, Update e Delete); contendo endpoints que possibilitam ler e escrever em arquivos utilizando o módulo fs do Node.js.

🎤💬 Talker Manager 🗣️🎙️

Descrição:

O projeto Talker Manager, desenvolvido no quarto bloco do módulo de Back-end da Trybe, envolveu a construção de uma API com um CRUD (Create, Read, Update e Delete) de palestrantes. A API contém endpoints que possibilitam ler e escrever em arquivos utilizando o módulo fs do Node.js. A execução do Talker Manager permitu a prática dos conteúdos que foram aprendidos ao longo do bloco em que ele foi desenvolvido, o quarto bloco do módulo de Back-end da Trybe. Esses aprendizados foram a cerca de Node.js, Express e protocolos HTTP, esses últimos sendo a base para qualquer comunicação de dados na Web.

Ferramentas utilizadas:

O projeto foi executado em um ambiente isolado, utilizando Docker;

Node.js é um software de código aberto multiplataforma, ele permitiu a execução de códigos JavaScript fora do browser;

O Express, um framework para aplicativos da web do Node.js, facilitou a construção de requisições com diferentes verbos HTTP e diferentes endpoints;

O Nodemon é uma biblioteca que auxiliou o desenvolvimento, reiniciando automaticamente o servidor cada vez que uma alteração foi salva;

O Postman foi fundamental para a criação e teste da API, permitindo solicitações HTTP e a leitura de suas respostas;

E finalmente, o Swagger, um framework que, independente da linguagem, auxilia a descrição, consumo e visualização APIs REST, foi utilizado para estruturar a documentação.

Rodando o projeto na sua máquina:

1. Escolha um diretório e clone o repositório utilizando git clone:

  git clone [e-mail]:AirelRibeiro/talker-manager.git

2. Acesse o diretório do projeto talker-manager e instale as dependências:

  cd talker-manager
  npm install

3. Então rode npm start para iniciar a aplicação:

  npm start

4. Por fim, acesse o projeto via navegador, usando a seguinte url:

  http://localhost:3000

5. Para acessar a documentação da API, vá para o endpoint /docs:

  http://localhost:3000/docs