replapi-fixed

REPLAPI.it

A Simple and Complete Repl.it API Package
Explore the docs »

View Package on NPM · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

The Repl.it GraphQL API is an extraordinary way to make projects unique and special, yet with the numerous packages available few such projects have been made. Why would that be? Most likely due to how complicated writing code can get and the limitations of their queries. My package, ReplAPI.it, changes that with a simple to use structure and many queries, some of which are:

• Queries for Data on Users (such as Profile, Posts, Comments)
• Queries for Data on Posts (such as Upvoters, Content)
• Queries for Data on Notifications (such as Reply Notifications, Achievement Notifications)
• Mutations for Commenting, Reporting, and Posting
• Queries for Data on Leaderboard (with filters such as cycles since)
• and lots more!

My package is also simple to use with it's class-based structure. Simply create a new class for you User, Post, or whatever you heart desires and use built in functions with options to query data your way.

Built With

• NodeJS

Getting Started

I suggest requiring the ReplAPI.it module until ES imports in NodeJS are stabilized.

Prerequisites

If you have not already download npm:

• npm

  npm install npm@latest -g

Installation

1. Install the latest version of the package

   $ npm install replapi-it

2. Require the package in your code

   const repl = require('replapi-it');

Usage

Using ReplAPI.it is very simple! Let's create a simple user and ask for their cycles:

const repl = require('replapi-it');

const myUser = new repl.User("RayhanADev");

async function getCycles() {
 let info = await myUser.profileData();
 let cycles = info.karma; // Yep, it's karma!
 console.log(`User Cycles: ${cycles}`)
}

getCycles()

Output:

User Cycles: 1008

That was fun! Now how about getting a specific post? Let's create a simple post and ask for it's title:

const repl = require('replapi-it');

const myPost = new repl.Post(78043);

async function getTitle() {
 let info = await myPost.postData();
 let title = info.title;
 console.log(`Post Title: ${title}`)
}

getTitle()

Output:

Post Title: Presenting... 🤔 RayhanADev 🤔? (GraphQL Success!)

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

I'm considering adding in support for Crosis communications after they distribute developer keys again. Right now I'm experimenting with WSS and eval.repl.it for code execution!

Contributing

Contributions are much appreciated, and if you know another query that should be implemented on this package, follow these steps!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

Contact

RayhanADev - @RayhanADev - [e-mail]

Project Link: https://github.com/RayhanADev/REPLAPI.it

Acknowledgements

• cursorweb aka mrlapizgithub for several dozen GraphQL queries
• kognise for open-sourcing eval.repl.it's usage
• mat-1 for their original Repl.it API package