Vsspaulasouza / TasksApp

Um app para gerenciar tarefas, feito com o objetivo de aprender um pouco mais sobre o desenvolvimento Backend

TasksApp

---

📝 Tabela de conteúdo

• Sobre
• Preview
• Construído usando
• Rodando o projeto
• Autor

🧐 Sobre

Um app para gerenciar tarefas, feito com o objetivo de aprender um pouco mais sobre o desenvolvimento Backend.

🎥 Preview

⛏️ Construído usando

• NestJs - Um framework Node.js para construir aplicações do lado do servidor
• React - Framework Javascript para criação de aplicações web

🏁 Rodando o projeto

Siga as seguintes instruções para rodar a aplicação em sua máquina.

Pré-requisitos

Para executar esse projeto, você vai precisar do Node, seu gerenciador de pacotes(npm), o Docker e o Docker Compose instalado em sua máquina.

Faça o clone do projeto e siga para seção Backend para rodar o servidor e Frontend para rodar a interface da aplicação

gh repo clone Vsspaulasouza/TasksApp

Backend

Abra a pasta do projeto e acesse a pasta da api

cd task-api

Instale todas as dependências do projeto

npm i

Configure o arquivo docker-compose.yml de acordo com as suas preferências

# docker-compose.yml example
services:
  dev-db:
    image: postgres:13
    ports:
      - YOUR_PORT
    environment:
      - POSTGRES_USER= YOUR_USERNAME
      - POSTGRES_PASSWORD= YOUR_PASSWORD
      - POSTGRES_DB= YOUR_DB_NAME
    networks:
      - myNetwork
networks:
  myNetwork:

Crie um arquivo .env, ele deve ter todas as variáveis presentes no arquivo .env.example. Certifique-se de que a DATABASE_URL esteja de acordo com o que está definido no docker-compose.yml

# .env.example, committed to repo
DATABASE_URL="postgresql://username:password@localhost:port/database_name"
JWT_SECRET="SecretKey"

Agora, é necessário subir o banco de dados e realizar as migrações

npm run db:dev:restart

Após isso, basta executar o projeto

npm run start

Pronto, a sua aplicação estará rodando em seu ambiente local no endereço http://localhost:3000.

Frontend

Abra a pasta do projeto e acesse a pasta da aplicação frontend

cd task-frontend

Instale todas as dependências do projeto

npm i

Após instalar as dependências, basta executar o projeto

npm run dev

Após isso será gerado um link para acesso à aplicação rodando em seu ambiente local.

---

✍️ Autor

| Vinícius Soares