Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jamesrswift/traw

Typescript Reddit API Wrapper
https://github.com/jamesrswift/traw

praw reddit reddit-api snoowrap typescript

Last synced: about 4 hours ago
JSON representation

Typescript Reddit API Wrapper

Host: GitHub
URL: https://github.com/jamesrswift/traw
Owner: jamesrswift
License: mit
Created: 2022-01-24T19:01:46.000Z (almost 3 years ago)
Default Branch: master
Last Pushed: 2023-03-06T03:04:20.000Z (almost 2 years ago)
Last Synced: 2025-01-08T11:41:11.577Z (7 days ago)
Topics: praw, reddit, reddit-api, snoowrap, typescript
Language: TypeScript
Homepage:
Size: 1.21 MB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 7
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        


[![Contributors][contributors-shield]][contributors-url]

[![Forks][forks-shield]][forks-url]

[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

[![MIT License][license-shield]][license-url]

[![LinkedIn][linkedin-shield]][linkedin-url]






  

    

  

  
TRAW


  


    a Typescript Reddit API Wrapper

    


    Explore the docs »

    


    


    View Demo

    ·

    Report Bug

    ·

    Request Feature

  



  Table of Contents

  


    

      About The Project

      

        Built With

      

    

    

      Getting Started

      

        Prerequisites

        Installation

      

    

    Usage

    Roadmap

    Contributing

    License

    Contact

    Acknowledgments

  


## About The Project

TRAW is a typescript reddit API wrapper, a successor to  [Snoowrap by Not An aardvark](https://github.com/not-an-aardvark/snoowrap). The main drive to start the project was to address the lack of maintenance on snoowrap, leading to out-of-date functions, and secondly, to address potential security concerns arrising from the modules upon which it relied. The opportunity was also taken to incorporate type safety by moving from javascript to typescript, leading hopefully to greater reliability presently and in the future, as well as improving the end-developer's experience by making some function calls more intuitive.

(back to top)


### Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

* [Axios](https://axios-http.com/)

* [Typescript](https://typescriptlang.org/)

(back to top)


## Getting Started

This is an example of how you may give instructions on setting up your project locally.

To get a local copy up and running follow these simple example steps.

### Prerequisites

This is an example of how to list things you need to use the software and how to install them.

* npm

  ```sh

  npm install npm@latest -g

  ```

### Installation

_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._

1. Get a free API Key at [https://example.com](https://example.com)

2. Clone the repo

   ```sh

   git clone https://github.com/your_username_/Project-Name.git

   ```

3. Install NPM packages

   ```sh

   npm install

   ```

4. Enter your API in `config.js`

   ```js

   const API_KEY = 'ENTER YOUR API';

   ```

(back to top)


## Usage

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.

_For more examples, please refer to the [Documentation](https://example.com)_

(back to top)


## Roadmap

- [ ] Reimplement Snoowrap features

- [ ] Improve function signatures

- [ ] Add working test-bed for better TDD

- [X] Add support for mod notes

See the [open issues](https://github.com/jamesxx/traw/issues) for a full list of proposed features (and known issues).

(back to top)


## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

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

(back to top)


## License

Distributed under the MIT License. See `LICENSE.txt` for more information.

(back to top)


## Contact

Your Name - [@your_twitter](https://twitter.com/your_username) - [email protected]

Project Link: [https://github.com/jamesxx/traw](https://github.com/jamesxx/traw)

(back to top)


## Acknowledgments

(back to top)


[contributors-shield]: https://img.shields.io/github/contributors/jamesxx/traw.svg?style=for-the-badge

[contributors-url]: https://github.com/jamesxx/traw/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/jamesxx/traw.svg?style=for-the-badge

[forks-url]: https://github.com/jamesxx/traw/network/members

[stars-shield]: https://img.shields.io/github/stars/jamesxx/traw.svg?style=for-the-badge

[stars-url]: https://github.com/jamesxx/traw/stargazers

[issues-shield]: https://img.shields.io/github/issues/jamesxx/traw.svg?style=for-the-badge

[issues-url]: https://github.com/jamesxx/traw/issues

[license-shield]: https://img.shields.io/github/license/jamesxx/traw.svg?style=for-the-badge

[license-url]: https://github.com/jamesxx/traw/blob/master/LICENSE.txt

[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555

[linkedin-url]: https://linkedin.com/in/othneildrew

[product-screenshot]: images/screenshot.png