{"id":21257681,"url":"https://github.com/edmilson-dk/redfox-test-api","last_synced_at":"2025-08-01T15:08:02.768Z","repository":{"id":258258017,"uuid":"352621967","full_name":"edmilson-dk/redfox-test-api","owner":"edmilson-dk","description":"App api made by me.","archived":false,"fork":false,"pushed_at":"2021-03-29T13:59:59.000Z","size":58,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-15T06:27:30.636Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/edmilson-dk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-29T11:40:24.000Z","updated_at":"2021-03-29T14:00:02.000Z","dependencies_parsed_at":"2024-10-18T07:13:53.345Z","dependency_job_id":null,"html_url":"https://github.com/edmilson-dk/redfox-test-api","commit_stats":null,"previous_names":["edmilson-dk/redfox-test-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/edmilson-dk/redfox-test-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edmilson-dk%2Fredfox-test-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edmilson-dk%2Fredfox-test-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edmilson-dk%2Fredfox-test-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edmilson-dk%2Fredfox-test-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/edmilson-dk","download_url":"https://codeload.github.com/edmilson-dk/redfox-test-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edmilson-dk%2Fredfox-test-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268248580,"owners_count":24219555,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-01T02:00:08.611Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-21T04:05:14.371Z","updated_at":"2025-08-01T15:08:02.750Z","avatar_url":"https://github.com/edmilson-dk.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RedFox - Teste para desenvolvedor web\n\n# Back-end \n\nEste é o back-end da aplicação, construida com cadastro de usuário e CRUD de pokemons\ncom direito a upload de imagem além de filtro de type, weather, e stat, seguindo boas práticas de programação\ne abstraindo toda a lógica em camadas.\n\n# Tópicos \n\n- [Tecologias](#techs)\n- [Rotas da aplicação](#routes)\n- [Rodando a aplicação](#execute)\n- [API online](#online)\n\n\u003ca id=\"techs\"\u003e\u003c/a\u003e\n## Tecnologias e bibliotecas utilizadas\n\n- [NodeJS](https://nodejs.org/en/)\n- [KnexJS](http://knexjs.org/)\n- [PostgreSQL](https://www.postgresql.org/)\n- [Multer](https://www.npmjs.com/package/multer)\n- [Sharp](https://sharp.pixelplumbing.com/)\n\n\u003ca id=\"routes\"\u003e\u003c/a\u003e\n## Rotas da aplicação\n\n### Públicas\n\n\u003e As rotas públicas não necessitam da auteticação do usuário.\n\n- ``/api/register`` \n\n| Data        | Resposta      | Ação \n|-------------|---------------|---------------------\n| name        | name          | Rota para criação de um usuário, com as credencias corretas\n| email       | email         |\n| password    | id            |\n|             | token         |\n\n\n- ``/api/login`` \n\n| Data        | Resposta      | Ação \n|-------------|---------------|---------------------\n| email       | email         | Fazer o login do usuário com email e senha corretos\n| password    | id            |\n|             | token         |\n\n## Privadas\n\n\u003e As rotas privadas necessitam da autenticação do usuário, além de que todas as rotas privadas\n\u003e utilizam o id do usuário armazenado no token que deve vim nos headers da resuisição, no formato de \"Bearer\n\u003e  token\"\n\n\n- ``/api/session/store`` \n\n| Data            | Resposta                          | Ação \n|-----------------|-----------------------------------|---------------------\n| name            | Nenhuma reposta é enviada em json | Rota para adicionar um novo pokemon\n| typeOne         |\n| typeTwo         |\n| imageName       |\n| weatherOne      | \n| weatherTwo      | \n| generation      |\n| evolutionStage  |      \n| familyId        |\n| atk             |\n| def             |\n| stat            |\n| raidable        |\n| hatchable       |\n| evolved         |\n| crossGender     |  \n| lengendary      | \n| acquirable      |  \n| spawns          |\n| regional        |\n| shiny           |\n| nest            |\n| newField        |\n| notGettable     |  \n| futureEvolve    |\n\n\n- ``/api/session/pokemon/id``\n\n| Data        | Resposta                  | Ação \n|-------------|---------------------------|---------------------\n| Nenhuma     | todos os dados do pokemon | Rota para obter todos os dados de um pokemon em específico\n\n\n- ``api/session/pokemons``\n- ``api/session/pokemons?type={type}``\n- ``api/session/pokemons?weather={weather}``\n- ``api/session/pokemons?min_stat={min_stat}\u0026max_stat={max_stat}``\n- ``api/session/pokemons?above={above}``\n\n| Data        | Resposta                       | Ação \n|-------------|--------------------------------|---------------------\n| Nenhuma     | todos os pokemons e seus dados | Rota para obter todos os pokemons e seus dados, com filtro via query na url da api                           \n\n\n- ``/api/session/update/id``\n\n| Data                     | Resposta     | Ação \n|--------------------------|--------------|---------------------\n| Dados a serem atualizaos | Nenhuma      | Rota para atualizar os dados de um pokemon, exceto sua imagem\n\n\n- ``/api/session/updateimage/id``\n\n| Data                     | Resposta     | Ação \n|--------------------------|--------------|---------------------\n| Novo arquivo de imagem   | Nenhuma      | Rota para atualizar a imagem de um pokemon\n\n\n- ``api/session/dropall``\n\n| Data      | Resposta     |Ação \n|-----------|--------------|--------------\n| Nenhuma   | Nenhuma      | Rota para deletar todos os pokemons do usuário\n\n\u003ca id=\"execute\"\u003e\u003c/a\u003e\n## Executando a API\n\nPara executar a api em sua máquina siga os passos abaixo.\n\n- 1 Clone meu repositório em sua máquina \n\n```sh\ngit clone git@github.com:edmilson-dk/teste-desenvolvimento-web.git\n\n# entre na pasta api\n\ncd teste-desenvolvimento-web/api\n```\n\n- 2 Após o passo acima, instale as dependências necessárias, para isso é preciso que você tenha o [NodeJS](https://nodejs.org/en/) instalado em sua máquina.\n\n```sh\nnpm install\n\n# ou com yarn\n\nyarn install\n```\n\n- 3 Feito a instalação de tudo é hora de configurar o banco de dados [PostgreSQL](https://www.postgresql.org/) \nem sua máquina, caso você não o tenha instalado, acesse o site do [PostgreSQL](https://www.postgresql.org/) e siga os passos de instalação em seu sistema operacional, quando instalar inicie o postgresql e entre na linha de comando dele ou em uma interface gráfica que você utilize, para podermos criar nossa database e nosso usuário para a api poder ser utilizada, no meu caso os comandos são os seguintes.\n\n```sh\n# Primeiro entro na linha de comandos do postresql e crio uma database.\n❯ sudo -u postgres psql\n[sudo] password for dk:         \npsql (12.6 (Ubuntu 12.6-0ubuntu0.20.04.1))\nType \"help\" for help.\n\npostgres$ CREATE DATABASE \"web_teste\";\npostgres$ \\q;\n\n# Após isso saiu da linha de comando em si, e entro na database que acabei de criar, para poder criar \n# uma role que é um tipo de usuário no postgresql, nela passamos o username que no meu caso eu escolhi\n# \"web_teste_user\" e passo algumas opções necessárias para a conexão além do meu password que botei como \n# \"webteste123\", após isso já podemos conectar nossa api ao banco de dados.\n\n❯ sudo -i -u postgres psql web_teste\npsql (12.6 (Ubuntu 12.6-0ubuntu0.20.04.1))\nType \"help\" for help.\n\nweb_teste$ CREATE ROLE web_teste_user CREATEDB LOGIN SUPERUSER PASSWORD 'webteste123';\npostgres$ \\q;\n```\n\n- 4 Após o processo acima, vamos adicionar nossas credências do banco em um arquivo de variaveis de ambiente, \nna pasta root do projeto que neste caso é a pasta ``api``, crie o arquivo .env e adicione a mesma marcação que esta presente no arquivo env.example que deixei disponivél no repositório, após fazer a marcação, adicione as credências, o seu .env deve ficar mais ou menos assim.\n\n```sh\n# o banco de dados que estamos utilizando, neste caso pg que significa postgres\nDB_CLIENT=pg\n\n# o mesmo nome da database que você criou\nDATABASE=web_teste \n\n# suas credências da database\nDB_USERNAME=web_teste_user\nDB_PASSWORD=webteste123\n\n# crie uma chave secreta, de preferência criptografada para ser única.\nSECRET=abasjkdbkajdo3y4beqwdgas\n\n# aqui você não mexe\nMIGRATIONS=./src/drivers/database/postgres/knex/migrations\n```\n\n- 5 Agora é só criarmos nossas [Migrations](https://medium.com/@juniorb2s/migrations-o-porque-e-como-usar-12d98c6d9269) para isso apenas execute o comando abaixo.\n\n```sh\nnpx knex migrate:latest\n```\n\n- 6 Por fim é só iniciar nossa api.\n\n```sh\nnpm dev \n\n# ou com yarn\n\nyarn dev\n```\n\n\u003ca id=\"online\"\u003e\u003c/a\u003e\n## Veja a aplicação funcionando\n\nCaso você não queira executar os passos de instalação manualmente, para sua sorte fiz o deploy da aplicação, a url da API é esta ``aqui``.\n\nCreator with 💙 by [Edmilson Jesus](https://www.linkedin.com/in/edmilson-jesus-4128711b5)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedmilson-dk%2Fredfox-test-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fedmilson-dk%2Fredfox-test-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedmilson-dk%2Fredfox-test-api/lists"}