https://github.com/vghessel/taskkiller
https://github.com/vghessel/taskkiller
docker mongodb-atlas nginx nodejs reactjs
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/vghessel/taskkiller
- Owner: vghessel
- Created: 2024-01-04T20:57:00.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-26T18:01:07.000Z (almost 2 years ago)
- Last Synced: 2025-02-27T17:22:57.169Z (over 1 year ago)
- Topics: docker, mongodb-atlas, nginx, nodejs, reactjs
- Language: JavaScript
- Homepage:
- Size: 2.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
**Uma To-Do List que simplifica sua vida: leve, fácil e eficiente. Organize suas tarefas com elegância, sem complicações.**
*Trabalho de conclusão de curso - Pós-Graduação em Desenvolvimento Full Stack (PUCRS)*
---
## Backend
***Tecnologias utilizadas:***
* Nodejs
* Express
* MongoDB
* Json Web Token (JWT)
* Docker
* Nginx
* Google Cloud Platform
* Mocha, Chai e Supertest (Unit Tests)
***Documentação da API:***
Para ver a documentação da API é só acessar o endpoint **/api-docs** que o arquivo swagger.yml será mostrado localmente no padrão do Swagger Editor.
Caso não esteja rodando o projeto, é possível fazer o upload do arquivo [swagger.yml](backend/swagger.yml) em [editor.swagger.io](https://editor.swagger.io/)
***Rodando a aplicação:***
1. Clone o repositório:
```bash
git clone https://github.com/vghessel/taskKiller.git
```
```bash
cd taskKiller
```
2. Instale as dependências:
```bash
cd backend && npm install
```
3. Crie e configure suas credenciais do MongoDB Atlas no arquivo backend/.env:
Neste caso é necessário ter acesso ao MongoDB Atlas que é um Cluster gratuíto na Cloud do MongoDB
```bash
MONGODB_URI=mongodb+srv://:@cluster7.tjnxkvv.mongodb.net/?retryWrites=true&w=majority
```
4. Inicialize o servidor:
```bash
cd backend && npm start
```
***Testando a aplicação:***
**Teste manual:**
Além de testar utilizando o Postman em conjunto com a documentação Swagger, é possível utilizar o arquivo request.rest com a extensao REST Client no VSCode para fazer as requisições ao banco de dados.
**Testes unitários:**
Mocha, Chai e Supertest serão responsáveis por esses testes, para isso rode:
```bash
npm test
```
---
## Frontend
***Tecnologias utilizadas:***
* JavaScript
* React
* Redux
* Iodash
* Material UI
***Rodando a aplicação:***
1. Clone o repositório:
```bash
git clone https://github.com/vghessel/taskKiller.git
```
```bash
cd taskKiller
```
2. Instale as dependências:
```bash
cd gui && yarn install
```
3. Inicialize a aplicação:
```bash
yarn start
```