|
62 | 62 |
|
63 | 63 | [](https://repl.it/@RayhanADev/REPLAPIit-Replit-API-Package) |
64 | 64 |
|
| 65 | +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: |
65 | 66 |
|
| 67 | +* Queries for Data on Users (such as Profile, Posts, Comments) |
| 68 | +* Queries for Data on Posts (such as Upvoters, Content) |
| 69 | +* Queries for Data on Notifications (such as Reply Notifications, Achievement Notifications) |
| 70 | +* Mutations for Commenting, Reporting, and Posting |
| 71 | +* Queries for Data on Leaderboard (with filters such as cycles since) |
| 72 | +* and lots more! |
66 | 73 |
|
| 74 | +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**. |
67 | 75 |
|
68 | 76 | ### Built With |
69 | 77 |
|
70 | 78 | * [NodeJS](https://github.com/nodejs/node) |
71 | 79 |
|
72 | | -<!-- GETTING STARTED --> |
73 | 80 | ## Getting Started |
74 | 81 |
|
75 | | -To get a local copy up and running follow these simple steps. |
| 82 | +I suggest requiring the ReplAPI.it module until ES imports in NodeJS are stabilized. |
76 | 83 |
|
77 | 84 | ### Prerequisites |
78 | 85 |
|
79 | | -This is an example of how to list things you need to use the software and how to install them. |
| 86 | +If you have not already download npm: |
80 | 87 | * npm |
81 | 88 | ```sh |
82 | 89 | npm install npm@latest -g |
83 | 90 | ``` |
84 | 91 |
|
85 | 92 | ### Installation |
86 | 93 |
|
87 | | -1. Clone the repo |
| 94 | +1. Install the latest version |
88 | 95 | ```sh |
89 | | - git clone https://github.com/RayhanADev/REPLAPI.it.git |
| 96 | + $ npm install replapi-it |
90 | 97 | ``` |
91 | | -2. Install NPM packages |
92 | | - ```sh |
93 | | - npm install |
| 98 | +2. Require the package |
| 99 | + ```js |
| 100 | + const repl = require('replapi-it'); |
94 | 101 | ``` |
95 | 102 |
|
96 | | - |
97 | | - |
98 | | -<!-- USAGE EXAMPLES --> |
99 | 103 | ## Usage |
100 | 104 |
|
101 | 105 | Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. |
|
0 commit comments