Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mazkdevf/educationgit
A JavaScript library for fetching real-time GitHub Student Pack benefits.
https://github.com/mazkdevf/educationgit
benefits developers edu education github javascript js pack
Last synced: 6 days ago
JSON representation
A JavaScript library for fetching real-time GitHub Student Pack benefits.
- Host: GitHub
- URL: https://github.com/mazkdevf/educationgit
- Owner: mazkdevf
- License: mit
- Created: 2023-07-12T12:18:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-12T12:50:50.000Z (over 1 year ago)
- Last Synced: 2024-12-08T12:22:03.588Z (25 days ago)
- Topics: benefits, developers, edu, education, github, javascript, js, pack
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/education-github-student-benefits
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EducationGit
A JavaScript library for fetching real-time GitHub Student Pack benefits. This library allows students to retrieve information about the benefits they have access to as part of the GitHub Student Developer Pack.
### Features
- Fetch real-time information about the GitHub Student Pack benefits.
- Retrieve details about individual benefits, such as name, description, and benefits.
- Filter benefits based on categories or specific keywords. [FILTERED ON TAGS]!
- Easy integration with your JavaScript projects.
### Installation
```bash
npm install education-github-student-benefits
```
### Usage
```js
const EducationGit = new (require("education-github-student-benefits"))();
EducationGit.getBenefits().then((res) => {
console.log(res);
}).catch((err) => {
console.error(err);
});
// GET FILTERS
EducationGit.getBenefits().then((res) => {
EducationGit.getAllFilters(res["benefits"]["list"]).then((res) => {
console.log(res["filters"]);
});
}).catch((err) => {
console.error(err);
});
// GET BENEFITS WITH FILTER
EducationGit.getBenefits().then((res) => {
EducationGit.filterBenefits(res["benefits"]["list"], "Cloud").then((res) => {
console.log(res);
});
}).catch((err) => {
console.error(err);
});
```
### Example Request Content:
```js
{
requestDate: {
timestamp: 1689164159356,
dateFormat: 'YYYY-MM-DD HH:mm:ss',
date: '2023-07-12 12:15:59'
},
benefits: {
count: 89,
list: [
[Object], [Object], [Object], [Object], [Object], [Object],
[Object], [Object], [Object], [Object], [Object], [Object],
[Object], [Object], [Object], [Object], [Object], [Object],
[Object], [Object], [Object], [Object], [Object], [Object],
[Object], [Object], [Object], [Object], [Object], [Object],
[Object], [Object], [Object], [Object], [Object], [Object],
[Object], [Object], [Object], [Object], [Object], [Object],
[Object], [Object], [Object], [Object], [Object], [Object],
[Object], [Object], [Object], [Object], [Object], [Object],
[Object], [Object], [Object], [Object], [Object], [Object],
[Object], [Object], [Object], [Object], [Object], [Object],
[Object], [Object], [Object], [Object], [Object], [Object],
[Object], [Object], [Object], [Object], [Object], [Object],
[Object], [Object], [Object], [Object], [Object], [Object],
[Object], [Object], [Object], [Object], [Object]
]
},
applyForGitHubStudentDeveloperPack: 'https://education.github.com/discount_requests/application',
information: {
source: 'https://education.github.com/pack',
libAuthor: 'mazkdevf',
libName: 'education-git-benefits',
libVersion: '1.0.3'
}
}
```
### Example Request Content for Filters & Filtered:
##### EducationGit.filterBenefits (FUNCTION)
```js
{
requestDate: {
timestamp: 1689166087812,
dateFormat: 'YYYY-MM-DD HH:mm:ss',
date: '2023-07-12 12:48:07'
},
benefits: {
count: 7,
list: [
[Object], [Object],
[Object], [Object],
[Object], [Object],
[Object]
]
},
applyForGitHubStudentDeveloperPack: 'https://education.github.com/discount_requests/application',
information: {
source: 'https://education.github.com/pack',
libAuthor: 'mazkdevf',
libName: 'education-git-benefits',
libVersion: '1.0.3'
},
filter: 'Cloud'
}
```
##### EducationGit.getAllFilters (FUNCTION)
```js
{
count: 14,
list: [
'Virtual Events',
'Domains',
'Cloud',
'Developer tools',
'Learn',
'Design',
'Infrastructure & APIs',
'Security & analytics',
'Mobile',
'Personal Portfolio',
'Machine Learning & AI',
'Internet of Things',
'Productivity',
'Marketing'
]
}
```
**Disclaimer:** This library is not officially endorsed or supported by GitHub. It is an independent project created by the community for educational purposes.