jamesxx / traw Goto Github PK

TRAW

a Typescript Reddit API Wrapper
Explore the docs »

View Demo · Report Bug · Request Feature

TRAW is a typescript reddit API wrapper, a successor to Snoowrap by Not An aardvark. 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)

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
• Typescript

(back to top)

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.

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

• npm

  npm install npm@latest -g

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
2. Clone the repo

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

3. Install NPM packages

   npm install

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';

(back to top)

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

(back to top)

• Reimplement Snoowrap features
• Improve function signatures
• Add working test-bed for better TDD
• Add support for mod notes

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

(back to top)

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)

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

(back to top)

Your Name - @your_twitter - [email protected] Project Link: https://github.com/jamesxx/traw

(back to top)

(back to top)