PTA

Esse boilerplate foi criado durante o processo seletivo de 2022 do CITi e atualizado em 2023.2 com o intuito de aproximar as pessoas aspirantes à realidade dentro do CITi. O boilerplate será usado durante a última etapa do processo seletivo, a qual tem o objetivo de capacitar tecnincamente as pessoas que entrarão no CITi.
Explore the docs »

· Report Bug · Request Feature

Tabela de Conteúdo

1. About Boilerplate
2. Server
• How To Install
• How To Run
• Citi Abstraction Documentation
• Are Values Undefined
• Insert Into Database
• Get All
• Find By ID
• Delete Value
• Update
3. Client
• How To Install Client
• How To Run Client
4. Add New Dependencies
5. Contact

About Boilerplate

Esse boilerplate foi criado durante o processo seletivo de 2022 do CITi e ele tem o intuito de aproximar as pessoas aspirantes à realidade dentro do CITi. O boilerplate será usado durante a última etapa do processo seletivo, a qual tem o objetivo de capacitar tecnincamente as pessoas que entrarão no CITi. O template foi criado em um monorepo e está estruturado em cliente e servidor.

O server tem uma estrutura base de código para a construção de uma API. Já o cliente, contém uma outra estrutura base de código para a construção de todo o frontend da aplicação. Ainda no server, tem uma abstração construída para facilitar o contato de pessoas aspirantes com a construção de uma API.

Server

How To Install

0. Certifique-se que o node esteja devidamente instalado.

1. Clone o repositório

   git clone URL_DO_REPOSITÓRIO

2. Entre na pasta /server do repositório

3. Abra a pasta /server no vscode

4. Vá em terminal e abra o novo terminal

5. Com o terminal aberto, escreva essa sentença abaixo e dê enter

   yarn install

   ou

   npm install

How To Run

0. Certifique-se que o docker esteja devidamente instalado

1. Com a pasta /server aberta no vscode, crie um novo arquivo e o nomeie de ".env"

2. Dentro desse novo arquivo criado, coloque esse texto abaixo

      ####### GENERAL SETTINGS #######
      PROJECT_NAME=pta
      
      # ###### SERVER SETTINGS #######
      SERVER_PORT=3001
      
      # ###### DATABASE SETTINGS #######
      DATABASE_TYPE=postgres
      DATABASE_HOST=${PROJECT_NAME}-db
      DATABASE_PORT=5432
      DATABASE_USER=postgres
      DATABASE_PASSWORD=docker
      DATABASE_DB=${PROJECT_NAME}
      DATABASE_URL=${DATABASE_TYPE}://${DATABASE_USER}:${DATABASE_PASSWORD}@${DATABASE_HOST}:${DATABASE_PORT}/${DATABASE_DB}

3. Abra um novo terminal no vscode

4. Com o terminal aberto, escreva essa sentença abaixo e dê enter

   docker-compose up

   ou

   docker compose up

5. Espere que o terminal esteja dessa maneira

   

Citi Abstraction Documentation

Are Values Undefined

Essa função verifica se existe um valor undefined passando no argumento.

• Observação: Essa função recebe quantos argumentos forem preciso.

   Retorna o booleano true caso exista valores undefnined

   Retorna o booleano false caso exista valores undefnined

Exemplo:

Insert Into Database

Essa função tem a finalidade de inserir um valor de modelo dentro de um banco de dados.

• Observação: Essa função recebe o novo objeto a ser inserido como argumentos.

 Retorna https 201 caso o procedimento ocorra de forma correta

 Retorna https 400 caso o procedimento NÃO ocorra de forma correta

Exemplo:

Get All

Essa função tem a finalidade de pegar TODOS os valores de modelo dentro de um banco de dados.

• Observação: Essa função não tem argumentos.

 Retorna https 200 caso o procedimento ocorra de forma correta

 Retorna https 400 caso o procedimento NÃO ocorra de forma correta

Exemplo:

Find By Id

Essa função tem a finalidade de procurar um valor de modelo dentro de um banco de dado, utilizando o ID.

• Observação: Essa função recebe o ID como argumento.

 Retorna o valor procurado caso o procedimento ocorra de forma correta

 Retorna undefined caso o procedimento NÃO ocorra de forma correta

Exemplo:

Delete Value

Essa função tem a finalidade de deletar um valor de modelo dentro de um banco de dado, utilizando o ID.

• Observação: Essa função recebe o ID como argumento.

 Retorna https 200 caso o procedimento ocorra de forma correta

 Retorna https 400 caso o procedimento NÃO ocorra de forma correta

Exemplo:

Update Value

Essa função tem a finalidade de atualizar um valor de modelo dentro de um banco de dado, utilizando o ID.

• Observação: Essa função recebe o ID e os novos valores como argumentos.

 Retorna https 200 caso o procedimento ocorra de forma correta

 Retorna https 400 caso o procedimento NÃO ocorra de forma correta

Exemplo:

Client

How To Install Client

1. Entre na pasta /client do repositório

2. Abra a pasta /client no vscode

3. Vá em terminal e abra o novo terminal

4. Com o terminal aberto, escreva essa sentença abaixo e dê enter

   yarn install

   ou

   npm install

How To Run Client

1. Entre na pasta /client do repositório

2. Abra a pasta /client no vscode

3. Vá em terminal e abra o novo terminal

4. Com o terminal aberto, escreva essa sentença abaixo e dê enter

   yarn dev

   ou

   npm run dev

5. Espere que o terminal esteja dessa maneira

   

Add New Dependencies

Não instale novas dependências sem a autorização da pessoa gerente do projeto. Caso seja preciso, converse com gerentes e peça direcionamento de como faz para adicionar.

Contact

• Alex Damascena, líder de desenvolvimento em 2022.1 - apfd@cin.ufpe.br
• Tiago Lima, líder de desenvolvimento em 2023.2 - tmsl@cin.ufpe.br

2022 Boilerplate

• apfdamascena/pta-boilerplate