Giter Club home page Giter Club logo

apitools's Introduction

APITools

Hello! This is a test repo for various tools related to APIs (specifically so far the GitHub API).

Talk Code-Along Instructions

If you are here for a code-along portion at a talk, welcome! I'll go over these instructions in the talk, but in case you miss something or are watching from home, here are the steps for coding along.

  1. Fork this repo and clone it locally.

  2. Check out the notifications-starter branch, then run the following commands in the project folder:

npm install

touch .env

This repository has two dependencies -- dotenv and node-fetch. Dotenv is for protecting your GitHub token and node-fetch is for making API calls. Feel free to use axios, another package, or Node to make the calls if you prefer.

  1. Make sure to add .env to your .gitginore if you plan to push this code to GitHub.

  2. Once your GitHub access token is generated, save it to your .env file as

TOKEN=<TOKEN HERE>

  1. Code in GetNotifications.js using the comment prompts to write a script that gets your notifications for a repository, saves any of the type security-alert to a file, then marks those notifications as read.

Scripts

Run the following scripts from the master branch in the root project directory.

Create Issues from JSON

File: CreateIssueFromJSON.js

cd CreateIssuesFromJSON node CreateIssuesFromJSON.js

or

npm run issues

Video Demo

Pull Commits Since Given Date

File PullCommitsSinceRelease.js

cd PullCommitsSinceRelease node PullCommitsSinceRelease.js

or

npm run commits

Get Security Notifications

File GetNotifications.js

cd GetNotifications node GetNotifications.js

or

npm run notifications

GitHub Emoji Tool

File: CopyEmojis.HTML

Open CopyEmojis.HTML in any browser.

Contributing

Interested in open source? First-time contributors welcome!

Contribution Ideas:

  • Create issues with feature requests or bug reports
  • Add documentation
  • Add error handling
  • Add features to existing tools
  • Add new tools
  • Refactor
  • Optional UIs

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.