README.md

Buscador.ao

Techs   |    Project   |    Avaliable Routes   |    How to Build Setup   |    How to Contribute   |    License   |    Author

🚀 Techs

Este projecto foi desenvolvido usando as seguintes tecnologias:

• Nestjs
• MongoDB

💻 Project

Ponto de obtenção de informações públicas - https://buscador.ao

Avaliable Routes

Rotas existentes no momento:

• [ deprecated ] nif/:nif permite retornar informações de um nif. ( No momento a rota existe, porém será eliminada posteriormente ).

  {
    "data": {
      "nif": ":nif:",
      "name": "Acidiney Alvaro  Carvalho Soares Dias",
    },
    "source": "Buscador"
  }

• [ NEW ] GET search/document, permite validar os documentos do tipo ['NIF', 'BI']. ( esses parametros type e number devem ser enviados como query, caso queira testar pelo navegar recomendo usar no metodo acima ) eg:

  • Para BI

    axios.get('https://buscador.ao/search/document', {
      type: 'BI',
      number: 'número do BI a ser válidado'
    })

  Isso deve retornar

    {
      "data": {
          "name": "ACIDINEY ALVARO CARVALHO SOARES DIAS",
          "bi": "meu-bi"
      },
      "source": "Buscador"
    }

  • Para NIF

    axios.get('https://buscador.ao/search/document', {
      type: 'NIF',
      number: 'número do NIF a ser válidado'
    })

  Isso deve retornar

    {
      "data": {
          "name": "ACIDINEY ALVARO CARVALHO SOARES DIAS",
          "nif": "meu-nif"
      },
      "source": "Buscador"
    }

How to Build Setup

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod
​```

## Test

​```bash
# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

🤔 How to Contribute

• Faça Fork deste repositório;
• Crie sua branch com a sua funcionalidade: git checkout -b my-feature;
• Commit suas mudanças: git commit -m 'feat: my new feature';
• Envie suas mudanças para o Githuh: git push origin my-feature.

Depois de feito merge da sua PR, pode apagar a branch!

📝 License

Este projecto está sobre licensa MIT. Verifique o arquivo LICENSE para mais informações.

Author

Acidiney Dias