saraivais / talker-manager

CRUD API to manage information about talkers using Node.js, Express.js, the Node.js fs module, Postman and Swagger. Project developed during the Back-end module at Trybe.

TALKER MANAGER 🎤

English 🇬🇧

Click to expand!

Description 📝

Talker Manager is a CRUD (Create, Read, Update and Delete) API of talkers. This API has endpoints that allow the user to read and write in a file using the Node.js fs module. The development of this project allowed me to put in practice what I learned of Node.js, Express.js and HTTP Protocols during the Back-end module at Trybe.

Technologies and Tools 🔧

Talker Manager was developed using Docker to create an isolated development environment. Using Express.js, a CRUD (Create, Read, Update and Delete) API was created to manage Talkers from a JSON file using Node.js fs module. Nodemon and Postman were used as development tools, as Nodemon allowed me to monitor scripts during construction and Postman let me test and design the endpoints. After the project's development, Swagger was then used to design and write it's documentation.

Installation 📋

1. Create a directory using the mkdir command:

  mkdir saraivais-projects

2. Access the directory using the cd command and clone the repository:

  cd saraivais-projects
  git clone [e-mail]:saraivais/talker-manager.git

3. Access the project directory and install it's dependencies:

  cd talker-manager
  npm i

4. Lastly, use the npm start command and access the API documentation via browser, using the following url

  http://localhost:3000

Português 🇧🇷

Clique para expandir!

Descrição 📝

Talker Manager é uma API CRUD (Criar, Ler, Atualizar e Excluir) de locutores. Essa API possui endpoints que permitem ao usuário ler e gravar em um arquivo usando o módulo Node.js fs. O desenvolvimento deste projeto me permitiu colocar em prática o que aprendi sobre Node.js, Express.js e Protocolos HTTP durante o módulo Back-end no Trybe.

Tecnologias e Ferramentas 🔧

O Talker Manager foi desenvolvido usando o Docker para criar um ambiente de desenvolvimento isolado. Usando Express.js, uma API CRUD (Create, Read, Update and Delete) foi criada para gerenciar Talkers de um arquivo JSON usando o módulo Node.js fs. Nodemon e Postman foram usados ​​como ferramentas de desenvolvimento, pois o Nodemon me permitiu monitorar scripts durante a construção e o Postman me permitiu testar e projetar os endpoints. Após o desenvolvimento do projeto, Swagger foi usado para projetar e escrever sua documentação.

Instalação 📋

1. Crie um diretório usando o comando mkdir:

  mkdir saraivais-projects

2. Acesse o diretório usando o comando cd e clone o repositório:

  cd saraivais-projects
  git clone [e-mail]:saraivais/talker-manager.git

3. Acesse o diretório do projeto e instale suas dependências:

  cd talker-manager
  npm i

4. Por fim, use o comando npm start e acesse a documentação da API via navegador, usando a seguinte url

  http://localhost:3000