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.
Explore the docs »
·
Report Bug
·
Request Feature
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.
-
Certifique-se que o node esteja devidamente instalado.
-
Clone o repositório
git clone URL_DO_REPOSITÓRIO
-
Entre na pasta /server do repositório
-
Abra a pasta /server no vscode
-
Vá em terminal e abra o novo terminal
-
Com o terminal aberto, escreva essa sentença abaixo e dê enter
yarn install
ou
npm install
-
Certifique-se que o docker esteja devidamente instalado
-
Com a pasta /server aberta no vscode, crie um novo arquivo e o nomeie de ".env"
-
Dentro desse novo arquivo criado, coloque esse texto abaixo
DATABASE_TYPE=postgres DATABASE_PORT=5432 DATABASE_HOST=pta-db DATABASE_USER=root DATABASE_PASSWORD=123456 DATABASE_NAME=pta DATABASE_DB=pta-one-page
-
Abra um novo terminal no vscode
-
Com o terminal aberto, escreva essa sentença abaixo e dê enter
docker-compose up
ou
docker compose up
-
Espere que o terminal esteja dessa maneira
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:
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 modelo de entidade e 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 corretaExemplo:
Essa função tem a finalidade de pegar TODOS os valores de modelo dentro de um banco de dados.
- Observação: Essa função recebe o modelo de entidade como argumento.
Retorna https 200 caso o procedimento ocorra de forma correta Retorna https 400 caso o procedimento NÃO ocorra de forma corretaExemplo:
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 modelo de entidade e 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 corretaExemplo:
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 modelo de entidade e o obejto a ser retirado como argumento.
Retorna https 200 caso o procedimento ocorra de forma correta Retorna https 400 caso o procedimento NÃO ocorra de forma corretaExemplo:
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 modelo de entidade, o ID e o novo objeto como argumentos.
Retorna https 200 caso o procedimento ocorra de forma correta Retorna https 400 caso o procedimento NÃO ocorra de forma corretaExemplo:
-
Entre na pasta /client do repositório
-
Abra a pasta /client no vscode
-
Vá em terminal e abra o novo terminal
-
Com o terminal aberto, escreva essa sentença abaixo e dê enter
yarn install
ou
npm install
-
Entre na pasta /client do repositório
-
Abra a pasta /client no vscode
-
Vá em terminal e abra o novo terminal
-
Com o terminal aberto, escreva essa sentença abaixo e dê enter
yarn start
ou
npm run start
-
Espere que o terminal esteja dessa maneira
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.
- Alex Damsacena - [email protected]