Skip to content
This repository was archived by the owner on Sep 6, 2021. It is now read-only.

Commit d2bd092

Browse files
rayhanadevrayhanadev
authored
Update README.md
1 parent afa39a8 commit d2bd092

1 file changed

Lines changed: 196 additions & 26 deletions

File tree

‎README.md‎

Lines changed: 196 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,196 @@
1-
# **An Unofficial Repl.it API**
2-
## *Easier Interactions in a Tiny Package*
3-
4-
The API.it package made by [@RayhanADev](https://repl.it/@RayhanADev) is a wrapper for Repl.it's GraphQL (and in the future REST and even Crosis) API. With multitudes of features such as:
5-
6-
- **Fetching User Data** (such as):
7-
- Profile Info (Date Joined, Profile Picture, Cycles, etc.)
8-
- Posts by Filter
9-
- Comments by Filter
10-
- **Fetching Post Data** (such as):
11-
- Title & Body
12-
- Author
13-
- Upvotes & Upvoters
14-
- Comments
15-
- Type
16-
- **Fetching Comment Data** (such as):
17-
- Body
18-
- Vote Count
19-
- Parent Comments
20-
- Answer to Question
21-
- **Fetching Repl Data** (such as):
22-
- Title
23-
- Embed Url
24-
- Time Created
25-
26-
## **How to Use?**
1+
<!--
2+
*** Thanks for checking out the Best-README-Template. If you have a suggestion
3+
*** that would make this better, please fork the repo and create a pull request
4+
*** or simply open an issue with the tag "enhancement".
5+
*** Thanks again! Now go create something AMAZING! :D
6+
***
7+
***
8+
***
9+
*** To avoid retyping too much info. Do a search and replace for the following:
10+
*** RayhanADev, REPLAPI.it, twitter_handle, rayhan.arayilakath@wa-students.org, REPLAPI.it, project_description
11+
-->
12+
13+
14+
15+
<!-- PROJECT SHIELDS -->
16+
<!--
17+
*** I'm using markdown "reference style" links for readability.
18+
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
19+
*** See the bottom of this document for the declaration of the reference variables
20+
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
21+
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
22+
-->
23+
[![Contributors][contributors-shield]][contributors-url]
24+
[![Forks][forks-shield]][forks-url]
25+
[![Stargazers][stars-shield]][stars-url]
26+
[![Issues][issues-shield]][issues-url]
27+
[![MIT License][license-shield]][license-url]
28+
[![LinkedIn][linkedin-shield]][linkedin-url]
29+
30+
31+
32+
<!-- PROJECT LOGO -->
33+
<br />
34+
<p align="center">
35+
<a href="https://github.com/RayhanADev/REPLAPI.it">
36+
<img src="images/logo.png" alt="Logo" width="80" height="80">
37+
</a>
38+
39+
<h3 align="center">REPLAPI.it</h3>
40+
41+
<p align="center">
42+
project_description
43+
<br />
44+
<a href="https://github.com/RayhanADev/REPLAPI.it"><strong>Explore the docs »</strong></a>
45+
<br />
46+
<br />
47+
<a href="https://github.com/RayhanADev/REPLAPI.it">View Demo</a>
48+
·
49+
<a href="https://github.com/RayhanADev/REPLAPI.it/issues">Report Bug</a>
50+
·
51+
<a href="https://github.com/RayhanADev/REPLAPI.it/issues">Request Feature</a>
52+
</p>
53+
</p>
54+
55+
56+
57+
<!-- TABLE OF CONTENTS -->
58+
<details open="open">
59+
<summary><h2 style="display: inline-block">Table of Contents</h2></summary>
60+
<ol>
61+
<li>
62+
<a href="#about-the-project">About The Project</a>
63+
<ul>
64+
<li><a href="#built-with">Built With</a></li>
65+
</ul>
66+
</li>
67+
<li>
68+
<a href="#getting-started">Getting Started</a>
69+
<ul>
70+
<li><a href="#prerequisites">Prerequisites</a></li>
71+
<li><a href="#installation">Installation</a></li>
72+
</ul>
73+
</li>
74+
<li><a href="#usage">Usage</a></li>
75+
<li><a href="#roadmap">Roadmap</a></li>
76+
<li><a href="#contributing">Contributing</a></li>
77+
<li><a href="#license">License</a></li>
78+
<li><a href="#contact">Contact</a></li>
79+
<li><a href="#acknowledgements">Acknowledgements</a></li>
80+
</ol>
81+
</details>
82+
83+
84+
85+
<!-- ABOUT THE PROJECT -->
86+
## About The Project
87+
88+
[![Product Name Screen Shot][product-screenshot]](https://example.com)
89+
90+
Here's a blank template to get started:
91+
**To avoid retyping too much info. Do a search and replace with your text editor for the following:**
92+
`RayhanADev`, `REPLAPI.it`, `twitter_handle`, `rayhan.arayilakath@wa-students.org`, `REPLAPI.it`, `project_description`
93+
94+
95+
### Built With
96+
97+
* []()
98+
* []()
99+
* []()
100+
101+
102+
103+
<!-- GETTING STARTED -->
104+
## Getting Started
105+
106+
To get a local copy up and running follow these simple steps.
107+
108+
### Prerequisites
109+
110+
This is an example of how to list things you need to use the software and how to install them.
111+
* npm
112+
```sh
113+
npm install npm@latest -g
114+
```
115+
116+
### Installation
117+
118+
1. Clone the repo
119+
```sh
120+
git clone https://github.com/RayhanADev/REPLAPI.it.git
121+
```
122+
2. Install NPM packages
123+
```sh
124+
npm install
125+
```
126+
127+
128+
129+
<!-- USAGE EXAMPLES -->
130+
## Usage
131+
132+
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.
133+
134+
_For more examples, please refer to the [Documentation](https://example.com)_
135+
136+
137+
138+
<!-- ROADMAP -->
139+
## Roadmap
140+
141+
See the [open issues](https://github.com/RayhanADev/REPLAPI.it/issues) for a list of proposed features (and known issues).
142+
143+
144+
145+
<!-- CONTRIBUTING -->
146+
## Contributing
147+
148+
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
149+
150+
1. Fork the Project
151+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
152+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
153+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
154+
5. Open a Pull Request
155+
156+
157+
158+
<!-- LICENSE -->
159+
## License
160+
161+
Distributed under the GPL-3.0 License. See `LICENSE` for more information.
162+
163+
164+
165+
<!-- CONTACT -->
166+
## Contact
167+
168+
RayhanADev - [@twitter_handle](https://twitter.com/twitter_handle) - rayhan.arayilakath@wa-students.org
169+
170+
Project Link: [https://github.com/RayhanADev/REPLAPI.it](https://github.com/RayhanADev/REPLAPI.it)
171+
172+
173+
174+
<!-- ACKNOWLEDGEMENTS -->
175+
## Acknowledgements
176+
177+
* []()
178+
* []()
179+
* []()
180+
181+
182+
183+
184+
185+
<!-- MARKDOWN LINKS & IMAGES -->
186+
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
187+
[contributors-shield]: https://img.shields.io/github/contributors/RayhanADev/repo.svg?style=for-the-badge
188+
[contributors-url]: https://github.com/RayhanADev/repo/graphs/contributors
189+
[forks-shield]: https://img.shields.io/github/forks/RayhanADev/repo.svg?style=for-the-badge
190+
[forks-url]: https://github.com/RayhanADev/repo/network/members
191+
[stars-shield]: https://img.shields.io/github/stars/RayhanADev/repo.svg?style=for-the-badge
192+
[stars-url]: https://github.com/RayhanADev/repo/stargazers
193+
[issues-shield]: https://img.shields.io/github/issues/RayhanADev/repo.svg?style=for-the-badge
194+
[issues-url]: https://github.com/RayhanADev/repo/issues
195+
[license-shield]: https://img.shields.io/github/license/RayhanADev/repo.svg?style=for-the-badge
196+
[license-url]: https://github.com/RayhanADev/repo/blob/master/LICENSE.txt

0 commit comments

Comments
 (0)