Skip to content

README.md

Latest commit

 

History

History
168 lines (114 loc) · 3.86 KB

README.md

File metadata and controls

168 lines (114 loc) · 3.86 KB
Typing SVG

One Interface. All Repositories. Infinite Possibilities.

License Docs

A futuristic framework that connects GitHub, GitLab, and more — all in one place.
Seamlessly transform raw API calls into elegant, UI-ready visual data with TypeScript and full analytics.

📘 Full Documentation:
🔗 Read the full guide here

📚 INDEX

1️⃣ Installation
2️⃣ Features
3️⃣ Basic Usage
4️⃣ Detailed Docs
5️⃣ Advanced Examples
6️⃣ Troubleshooting
7️⃣ Contributing
8️⃣ Changelog
9️⃣ License

1️⃣ INSTALLATION

npm install @luisotavio13/github-framework@1.0.0

2️⃣ FEATURES

✨ Unified APIs for GitHub, GitLab & more
✨ Full user and repository data
✨ Dynamic sorting for repositories
✨ Language usage graphs
✨ Contribution history & commit stats
✨ Ready-to-render UI components
✨ Strong TypeScript typing

3️⃣ BASIC USAGE

import GitHubAPIHelper from '@luisotavio13/github-framework';

const config = {
  username: 'your-username',
  token: 'your-token' // optional
};

const apiHelper = new GitHubAPIHelper(config);

await apiHelper.loadAllData();

console.log(apiHelper.userData);
console.log(apiHelper.reposData);
console.log(apiHelper.languagesData);

const profile = apiHelper.renderProfile();
const repos = apiHelper.renderRepos('stars');
const charts = apiHelper.renderCharts();

4️⃣ DETAILED DOCS

Documentation lives in the /docs folder:

5️⃣ ADVANCED EXAMPLES

📈 Contribution Monitoring:

const monthlyContributions = apiHelper.contributionsData;

🧪 Top Used Languages:

const topLanguages = Object.entries(apiHelper.languagesData)
  .sort((a, b) => b[1] - a[1])
  .slice(0, 3);

6️⃣ TROUBLESHOOTING

See TROUBLESHOOTING.md for help with:

  • 🔐 Authentication errors
  • 🚫 API rate limit exceeded
  • 🔒 Private repositories
  • 🌐 Proxy configuration

7️⃣ CONTRIBUTING

We welcome contributions! Please read CONTRIBUTING.md for:

  • Git workflow
  • Code standards
  • Test automation
  • Documentation guidelines

8️⃣ CHANGELOG

Track version history in:
📜 CHANGELOG.md

9️⃣ LICENSE

Licensed under the GNU GPL v3.0.
Read the LICENSE file.
For API legal info, see: LEGAL.md

📬 SUPPORT

For issues, suggestions or bug reports:
📮 Open an issue or contact: ✉️ roberdoogarcia@gmail.com