kbrandaolira / orbita Goto Github PK

1- Instale o Node (https://nodejs.org/en/download/).

2- Instale o Github (https://desktop.github.com/).

3- Instale o Mongo DB (https://www.mongodb.com/download-center#community).

4- Clone o Projeto através da URL https://github.com/kbrandaolira/orbita.git.

5- Crie uma base de dados chamada orbita

6- Importe o arquivo solar_data.json que está dentro da pasta /backend/db_import (Utilizei o programa Studio 3T (https://studio3t.com/) pois tive problema ao tentar importar pelo Mongo Compass).

7- A conexão com o banco de dados é feita no arquivo app.js e a senha está no arquivo nodemon.js, ambas dentro da pasta /backend.

8- Acesse as pastas de backend (porta 3001) e frontend (porta 3000) e rode o comando npm start para subir os projetos.

Descrição:

Serviço responsável pelo login do usuário, recebe os parâmetros email e password.

Exemplo de Requisição:

{
	"email":"[email protected]",
	"password":"12345678"
}

Exemplo de Resposta de Sucesso:

{
    "message": "Auth successful",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1NjE4Mzg1MzYsInVzZXJJZCI6IjVkMTJkMjM3MTJjNTc5MDM3ODJmMTgyYyIsImlhdCI6MTU2MTgzNDkzNn0.A3HHPNhk0cDhl7Xk3xkwyKVtCDVEKhr7ugS3LuyUwPg",
    "userId": "5d12d23712c57903782f182c"
}

Exemplo de Resposta de Falha:

{
    "message": "Auth failed"
}

Descrição:

Serviço responsável por trazer todos os usuários da aplicação.

Exemplo de Resposta:

{
    "count": 2,
    "users": [
        {
            "_id": "5d12d23712c57903782f182c",
            "name": "KAYAN BRANDAO LIRA",
            "password": "$2b$10$GbpOSxEog34ywViKdLS3C.pxAm3UnWf3NjhPSJ9Am7lQJZeyaa4fq",
            "email": "[email protected]"
        },
        {
            "_id": "5d151f2ba98d7936445b4711",
            "name": "Natacha Salvador",
            "password": "$2b$10$zFnivKMAze1E0TT22TRhR.kM.Ud2/1xPOjnTN8F0gBQL7cTXmaL3S",
            "email": "[email protected]"
        }
    ]
}

Descrição:

Serviço responsável por criar um novo usário.

Exemplo de Requisição:

{
	"name":"Kayan Brandão Lira",
	"email":"[email protected]",
	"password":"12345678",
	"state":"CA"
}

Exemplo de Resposta:

{
    "message": "User created",
    "userCreated": {
        "_id": "5d12d23712c57903782f182c",
        "name": "Kayan Brandão Lira",
        "password": "$2b$10$hp5AIQD8TU14i4mocCb0Butaw91YZG2I68FJJziIXdikCdL7g837G",
        "email": "[email protected]",
        "state": "CA",
        "__v": 0
    }
}

Descrição:

Serviço responsável por excluir um usuário através do id passado pela url.

Exemplo de Resposta:

{
    "n": 1,
    "ok": 1,
    "deletedCount": 1
}

Descrição:

Serviço responsável por trazer o número total de instalações do estado do usuário logado.

Observação:

Necessário adicionar Authorization no Header com o token de autenticação recebido no get /users/login.

Exemplo de Resposta:

{
    "count": 44218,
    "state": "CA"
}

Descrição:

Serviço responsável por trazer CEP e a instalação mais cara com seu valor do estado do usuário logado.

Observação:

Necessário adicionar Authorization no Header com o token de autenticação recebido no get /users/login.

Exemplo de Resposta:

{
    "installation": {
        "_id": "5d141dbfea500b4cae87e958",
        "zipCode": "90026",
        "cost": 999.8804775
    }
}

Descrição:

Serviço responsável por trazer o número de instalações por mês do estado do usuário logado.

Observação:

Necessário adicionar Authorization no Header com o token de autenticação recebido no get /users/login.

Exemplo de Resposta:

{
    "months": [
        {
            "month": "january",
            "count": 4117
        },
        {
            "month": "february",
            "count": 3092
        },
        {
            "month": "march",
            "count": 3660
        },
        {
            "month": "april",
            "count": 3381
        },
        {
            "month": "may",
            "count": 3306
        },
        {
            "month": "june",
            "count": 3377
        },
        {
            "month": "july",
            "count": 3730
        },
        {
            "month": "august",
            "count": 3608
        },
        {
            "month": "september",
            "count": 3843
        },
        {
            "month": "october",
            "count": 4387
        },
        {
            "month": "november",
            "count": 3774
        },
        {
            "month": "december",
            "count": 3943
        }
    ]
}

Componente de que desenha um painel com a class card do bootstrap no qual recebe os parâmetros title e description.

Responsável por renderizar o dashboard após o login do usuário, ele chama outros três componentes que são: InstallationsMade, HigherCostInstallation e ThreeMonthsMoreInstallations.

Responsável por renderizar o Footer da aplicação.

Responsável por renderizar o Header da aplicação.

Traz dentro de um Card o CEP que obteve a instalação com maior custo no estado do usuário logado.

Traz dentro de um Card o número de instalações feitas no estado do usuário logado.

Componente responsável por renderizar a tela de login com opção de criação de conta.

Modal chamado no componente de Login para o usuário criar sua conta.

Caso o usuário tente acessar uma página que não existe este componente será renderizado com erro 404.

Traz dentro de um Card os três meses que mais tiveram instalações no estado do usuário logado.