https://github.com/jthftc/first-npm

:open_file_folder: An NPM Repository for Retrieving FIRST Robotics Statistics (FTC & FRC)
https://github.com/jthftc/first-npm

first first-npm first-robotics-competition first-tech-challenge frc ftc robotics

Last synced: 11 days ago
JSON representation

:open_file_folder: An NPM Repository for Retrieving FIRST Robotics Statistics (FTC & FRC)

• Host: GitHub
• URL: https://github.com/jthftc/first-npm
• Owner: jthftc
• License: mit
• Created: 2020-11-22T21:59:03.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-01-02T01:10:43.000Z (almost 4 years ago)
• Last Synced: 2024-10-17T08:00:58.379Z (27 days ago)
• Topics: first, first-npm, first-robotics-competition, first-tech-challenge, frc, ftc, robotics
• Language: JavaScript
• Homepage: http://javathehutts.org
• Size: 471 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


The `first-npm` package is mainly for ultilizing the FIRST Robotics API in a Node.JS environment.

Follow [@javathehutts](https://twitter.com/javathehutts) on Twitter for important

announcements.

## Installation

To install prebuilt `first-npm` binaries, use [`npm`](https://docs.npmjs.com/):

```sh

npm install first-npm --save

```

## Programmatic usage

If you require `first-npm` inside

your **Node Application** this to spawn an `first-npm` reference from inside your Node scripts:

```javascript

//Spawn the first-npm Node module within your Node script

const First = require("first-npm");

//Used to login to the FIRST Robotics API (More Information Below)

const ftc = new First("username", "API-Key");

//Grab the information associated with the team #14725 (Java The Hutts)

ftc.getTeam(14725).then((response) => {

  console.log(response);

});

```

Get your FIRST Robotics `username` and `API-Key` from the [FTC](https://ftc-events.firstinspires.org/services/API) and [FRC](https://frc-events.firstinspires.org/services/API) API request pages respectively

## License

[MIT](https://github.com/electron/electron/blob/master/LICENSE)

When using the `first-npm` or other GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).