contribute/index.html

<!doctype html><html lang="en" class="no-js"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><meta http-equiv="x-ua-compatible" content="ie=edge"><meta name="description" content="Advanced information gathering & OSINT tool for phone numbers."><meta name="author" content="Sundowndev"><meta name="lang:clipboard.copy" content="Copy to clipboard"><meta name="lang:clipboard.copied" content="Copied to clipboard"><meta name="lang:search.language" content="en"><meta name="lang:search.pipeline.stopwords" content="True"><meta name="lang:search.pipeline.trimmer" content="True"><meta name="lang:search.result.none" content="No matching documents"><meta name="lang:search.result.one" content="1 matching document"><meta name="lang:search.result.other" content="# matching documents"><meta name="lang:search.tokenizer" content="[\s\-]+"><link rel="shortcut icon" href="../images/logo.svg"><meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.3.1"><title>Contribute - PhoneInfoga</title><link rel="stylesheet" href="../assets/stylesheets/application.4031d38b.css"><link rel="stylesheet" href="../assets/stylesheets/application-palette.224b79ff.css"><meta name="theme-color" content="#546e7a"><script src="../assets/javascripts/modernizr.74668098.js"></script><link href="https://fonts.gstatic.com" rel="preconnect" crossorigin><link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono&display=swap"><style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style><link rel="stylesheet" href="../assets/fonts/material-icons.css"></head><body dir="ltr" data-md-color-primary="blue-grey" data-md-color-accent="brown"><svg class="md-svg"><defs><svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="__github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg></defs></svg> <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> <label class="md-overlay" data-md-component="overlay" for="__drawer"></label><a href="#contribute" tabindex="1" class="md-skip">Skip to content </a><header class="md-header" data-md-component="header"><nav class="md-header-nav md-grid"><div class="md-flex"><div class="md-flex__cell md-flex__cell--shrink"><a href=".." title="PhoneInfoga" class="md-header-nav__button md-logo"><img src="../images/logo_white.svg" width="24" height="24"></a></div><div class="md-flex__cell md-flex__cell--shrink"><label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label></div><div class="md-flex__cell md-flex__cell--stretch"><div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"><span class="md-header-nav__topic">PhoneInfoga</span><span class="md-header-nav__topic">Contribute</span></div></div><div class="md-flex__cell md-flex__cell--shrink"><label class="md-icon md-icon--search md-header-nav__button" for="__search"></label><div class="md-search" data-md-component="search" role="dialog"><label class="md-search__overlay" for="__search"></label><div class="md-search__inner" role="search"><form class="md-search__form" name="search"><input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> <label class="md-icon md-search__icon" for="__search"></label> <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">&#xE5CD;</button></form><div class="md-search__output"><div class="md-search__scrollwrap" data-md-scrollfix><div class="md-search-result" data-md-component="result"><div class="md-search-result__meta">Type to start searching</div><ol class="md-search-result__list"></ol></div></div></div></div></div></div><div class="md-flex__cell md-flex__cell--shrink"><div class="md-header-nav__source"><a href="https://github.com/sundowndev/PhoneInfoga/" title="Go to repository" class="md-source" data-md-source="github"><div class="md-source__icon"><svg viewBox="0 0 24 24" width="24" height="24"><use xlink:href="#__github" width="24" height="24"></use></svg></div><div class="md-source__repository">sundowndev/PhoneInfoga</div></a></div></div></div></nav></header><div class="md-container"><main class="md-main"><div class="md-main__inner md-grid" data-md-component="container"><div class="md-sidebar md-sidebar--primary" data-md-component="navigation"><div class="md-sidebar__scrollwrap"><div class="md-sidebar__inner"><nav class="md-nav md-nav--primary" data-md-level="0"><label class="md-nav__title md-nav__title--site" for="__drawer"><a href=".." title="PhoneInfoga" class="md-nav__button md-logo"><img src="../images/logo_white.svg" width="48" height="48"></a>PhoneInfoga</label><div class="md-nav__source"><a href="https://github.com/sundowndev/PhoneInfoga/" title="Go to repository" class="md-source" data-md-source="github"><div class="md-source__icon"><svg viewBox="0 0 24 24" width="24" height="24"><use xlink:href="#__github" width="24" height="24"></use></svg></div><div class="md-source__repository">sundowndev/PhoneInfoga</div></a></div><ul class="md-nav__list" data-md-scrollfix><li class="md-nav__item"><a href=".." title="Welcome" class="md-nav__link">Welcome</a></li><li class="md-nav__item"><a href="../install/" title="Installation" class="md-nav__link">Installation</a></li><li class="md-nav__item"><a href="../usage/" title="Basic usage" class="md-nav__link">Basic usage</a></li><li class="md-nav__item"><a href="../formatting/" title="Formatting phone numbers" class="md-nav__link">Formatting phone numbers</a></li><li class="md-nav__item"><a href="../googlesearch/" title="Dealing with Google captcha" class="md-nav__link">Dealing with Google captcha</a></li><li class="md-nav__item"><a href="../resources/" title="Resources" class="md-nav__link">Resources</a></li><li class="md-nav__item md-nav__item--active"><input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"><label class="md-nav__link md-nav__link--active" for="__toc">Contribute</label><a href="./" title="Contribute" class="md-nav__link md-nav__link--active">Contribute</a><nav class="md-nav md-nav--secondary"><label class="md-nav__title" for="__toc">Table of contents</label><ul class="md-nav__list" data-md-scrollfix><li class="md-nav__item"><a href="#project" title="Project" class="md-nav__link">Project</a><nav class="md-nav"><ul class="md-nav__list"><li class="md-nav__item"><a href="#installation" title="Installation" class="md-nav__link">Installation</a></li><li class="md-nav__item"><a href="#structure" title="Structure" class="md-nav__link">Structure</a></li></ul></nav></li><li class="md-nav__item"><a href="#documentation" title="Documentation" class="md-nav__link">Documentation</a><nav class="md-nav"><ul class="md-nav__list"><li class="md-nav__item"><a href="#install-mkdocs" title="Install mkdocs" class="md-nav__link">Install mkdocs</a></li><li class="md-nav__item"><a href="#serve-documentation-on-localhost" title="Serve documentation on localhost" class="md-nav__link">Serve documentation on localhost</a></li><li class="md-nav__item"><a href="#deploy-on-github-pages" title="Deploy on github pages" class="md-nav__link">Deploy on github pages</a></li></ul></nav></li></ul></nav></li></ul></nav></div></div></div><div class="md-sidebar md-sidebar--secondary" data-md-component="toc"><div class="md-sidebar__scrollwrap"><div class="md-sidebar__inner"><nav class="md-nav md-nav--secondary"><label class="md-nav__title" for="__toc">Table of contents</label><ul class="md-nav__list" data-md-scrollfix><li class="md-nav__item"><a href="#project" title="Project" class="md-nav__link">Project</a><nav class="md-nav"><ul class="md-nav__list"><li class="md-nav__item"><a href="#installation" title="Installation" class="md-nav__link">Installation</a></li><li class="md-nav__item"><a href="#structure" title="Structure" class="md-nav__link">Structure</a></li></ul></nav></li><li class="md-nav__item"><a href="#documentation" title="Documentation" class="md-nav__link">Documentation</a><nav class="md-nav"><ul class="md-nav__list"><li class="md-nav__item"><a href="#install-mkdocs" title="Install mkdocs" class="md-nav__link">Install mkdocs</a></li><li class="md-nav__item"><a href="#serve-documentation-on-localhost" title="Serve documentation on localhost" class="md-nav__link">Serve documentation on localhost</a></li><li class="md-nav__item"><a href="#deploy-on-github-pages" title="Deploy on github pages" class="md-nav__link">Deploy on github pages</a></li></ul></nav></li></ul></nav></div></div></div><div class="md-content"><article class="md-content__inner md-typeset"><a href="https://github.com/sundowndev/PhoneInfoga/edit/master/docs/contribute.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a><h1 id="contribute">Contribute</h1>
<p>This page describe the project structure and gives you a bit of help to start developing.</p>
<p>The project is maintained by a single person: <a href="https://github.com/sundowndev">sundowndev</a>. Contributions are welcome.</p>
<p>You want to contribute ? Clone the project and open some pull requests !</p>
<h2 id="project">Project</h2>
<h3 id="installation">Installation</h3>
<p>See the <a href="../install/">installation page</a> to install the project.</p>
<h3 id="structure">Structure</h3>
<pre><code>├── docs
│   ├── contribute.md
│   ├── formatting.md
│   ├── googlesearch.md
│   ├── index.md
│   ├── install.md
│   ├── resources.md
│   └── usage.md
├── examples
│   ├── generate.sh
│   ├── input.txt
│   ├── output_from_input.txt
│   └── output_single.txt
├── lib
│   ├── args.py
│   ├── banner.py
│   ├── colors.py
│   ├── format.py
│   ├── googlesearch.py
│   ├── __init__.py
│   ├── logger.py
│   ├── output.py
│   └── request.py
├── osint
│   ├── disposable_num_providers.json
│   ├── individuals.json
│   ├── reputation.json
│   └── social_medias.json
├── scanners
│   ├── footprints.py
│   ├── __init__.py
│   ├── localscan.py
│   ├── numverify.py
│   ├── ovh.py
│   └── recon.py
├── config.example.py
├── Dockerfile
├── LICENSE
├── mkdocs.yml
├── phoneinfoga.py
├── README.md
└── requirements.txt
</code></pre>

<h2 id="documentation">Documentation</h2>
<p>We use <a href="https://www.mkdocs.org/">mkdocs</a> to write our documentation.</p>
<h3 id="install-mkdocs">Install mkdocs</h3>
<pre><code>python3 -m pip install mkdocs
</code></pre>

<h3 id="serve-documentation-on-localhost">Serve documentation on localhost</h3>
<pre><code>mkdocs serve
</code></pre>

<h3 id="deploy-on-github-pages">Deploy on github pages</h3>
<pre><code>mkdocs gh-deploy
</code></pre></article></div></div></main><footer class="md-footer"><div class="md-footer-nav"><nav class="md-footer-nav__inner md-grid"><a href="../resources/" title="Resources" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"><div class="md-flex__cell md-flex__cell--shrink"><i class="md-icon md-icon--arrow-back md-footer-nav__button"></i></div><div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"><span class="md-flex__ellipsis"><span class="md-footer-nav__direction">Previous</span>Resources</span></div></a></nav></div><div class="md-footer-meta md-typeset"><div class="md-footer-meta__inner md-grid"><div class="md-footer-copyright"><div class="md-footer-copyright__highlight">PhoneInfoga was developed by sundowndev and is licensed under GPL-3.0.</div>powered by <a href="https://www.mkdocs.org">MkDocs</a> and <a href="https://squidfunk.github.io/mkdocs-material/">Material for MkDocs</a></div><div class="md-footer-social"><link rel="stylesheet" href="../assets/fonts/font-awesome.css"> <a href="https://github.com/sundowndev/PhoneInfoga" class="md-footer-social__link fa fa-github"></a>  <a href="https://twitter.com/sundowndev" class="md-footer-social__link fa fa-twitter"></a> </div></div></div></footer></div><script src="../assets/javascripts/application.b260a35d.js"></script><script>app.initialize({version:"1.0.4",url:{base:".."}})</script></body></html>