PLF-ES-2023-1-MON-CursoNodeJS

---

Curso de monitoria
Como criar uma API RESTful com NodeJS

Sobre   |    Monitor   |    Professor responsável   |    Tecnologias   |    Instruções de utilização   |    Licença

---

🔖 Sobre

Curso de programação para apoio da disciplina Trabalho Interdisciplinar Aplicações para Processos de Negócios do 2º período de Engenharia de Software, PucMinas Praça da Liberdade 2023/1.

Neste curso é abordado como criar uma API RESTful com NodeJS. Conteúdo inclui vídeo aulas de explicações teóricas, instalação de ferramentas, prática focada no código e como consumir a API pelo Postman. Além disso, é apresentado como criar uma simples interface web em HTML, CSS e Script (também com a biblioteca Booststrap) que consume esta API.

Esta é uma simples aplicação onde usuário podem se cadastrar e registrarem tarefas para sua conta.

---

👨‍💻 Monitor

• Lucas Ângelo Oliveira Martins Rocha

---

👩‍🏫 Professor responsável

• Hugo Bastos De Paula

---

🚀 Tecnologias

• Frontend:
  • HTML 5
  • CSS 3
  • JavaScript
  • Bootstrap 5
• Backend:
  • NodeJS 16.19.0
• Database:
  • MySQL Server
• Ferramenta
  • Visual Studio Code (VSCode)
  • Postman
  • Git
  • Docker

---

⤵ Instruções de utilização

Essas instruções vão te levar a uma cópia do projeto rodando em sua máquina local para propósitos de testes, desenvolvimento e aprendizagem.

Pré-requisitos:

• Ter instalado todas as ferramentas e dependências ensinadas no vídeo Aula 02 - Instalação de todas as ferramentas e configuração de ambiente
  • NodeJS
  • NPM
  • MySQL
  • Docker (Docker-Compose)

• Passo 1: Clonar o repositório:

  $ git clone https://github.com/ICEI-PUC-Minas-PPLES-TI/PLF-ES-2023-1-MON-CursoNodeJS.git

• Passo 2: Configurar e iniciar a API NodeJS (backend)

  • Passo 2.1: Criar o arquivo .env pelo .env.sample:

  $ vi PLF-ES-2023-1-MON-CursoNodeJS\.env

  • Passo 2.2: Configurar as variáveis de ambiente:

    APP_DEBUG=true
  
    NODE_APP_HOST=localhost
  
    NODE_LOCAL_PORT=3001
    NODE_DOCKER_PORT=3000
  
    MYSQL_HOST=localhost
    MYSQL_LOCAL_PORT=3307
    MYSQL_DOCKER_PORT=3306
    MYSQL_DATABASE=todosimple
    MYSQL_USERNAME=root
    MYSQL_PASSWORD=root
  
    SECRET_KEY=v9y$B&EH@McQfTjWnZr4t7w!z%C*F-JaNdRgUkXp2s5v8y/A?DG+KbPeShVmYq

  • Passo 2.3: Ir para a pasta raíz do projeto:

  $ cd PLF-ES-2023-1-MON-CursoNodeJS\

  • Passo 2.4: Abrir o terminal e instalar as dependências do projeto utilizando o NPM:

  $ npm install

  • Passo 2.4: Iniciar a aplicação NodeJS:

    • Passo 2.4.1: Iniciar a aplicação NodeJS utilizando o NPM:

    $ npm run start

    ou

    • Passo 2.4.1: Iniciar a aplicação utilizando Docker-Compose:

    $ docker-compose up

  • API estará rodando em http://localhost:3001/

• Passo 3: Entrar na aplicação frontend após subir a API

  • Passo 3.1: Entrar na pasta raíz do projeto:

  $ cd PLF-ES-2023-1-MON-CursoNodeJS\

  • Passo 3.2: Abrir o arquivo index.html diretamente ou pela extensão Live Server do VsCode:

  $ cd PLF-ES-2023-1-MON-CursoNodeJS\view\login.html

  • Frontend estará rodando em http://127.0.0.1:5500/view/login.html caso iniciado com Live Server.

---

🔗 Links do projeto

• Playlist do Youtube com vídeos do curso
• Slide de apresentação
• Documento de ferramentas e configuração de ambiente

---

📝 Licença

Esse projeto está sob a licença MIT License. Veja o arquivo LICENSE para mais detalhes.

---