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

https://github.com/Juangmar/twitter_bots

A few twitter bots and it's API documentartion
https://github.com/Juangmar/twitter_bots

api-documentartion automated developer-experience javascript learning-by-doing twitter twitter-bot

Last synced: about 1 year ago
JSON representation

A few twitter bots and it's API documentartion

Awesome Lists containing this project

README

          

# TWITTER BOTS
A few twitter bots and it's API documentartion

## Getting Started

This project has been developed using JavaScript, connecting to the Twitter API and executing using Node.js.

Altough every node module has been 'installed' in every project package, it's recomended to manually install them befor execute the bots.

### Prerequisites

To execute any bot you must create a .json file with the user authentication in the same directory as the .js runnable flie.

The .json file must have the next content:
```javascript
{
"consumer_key": "----------",
"consumer_secret": "----------",
"access_token": "----------",
"access_token_secret": "----------",
}
```
Where the lines must be replaced with your own cretendial. Those credentials are asociated with your own app, created with a Twitter user via [it's own page](https://apps.twitter.com/)

## Documentation

Every JavaScript file is documented, but I'm writing a [wiki page](https://github.com/Juangmar/twitter_bots/wiki) with more detailed information, including every info I've found or discovered regarding the API methods and objects.

## Contributing

*Twitter Bots* is an open source project, so anyone can contribute to develop the bots, and we encourage you to do so.

Even though every pull request will be considered and possibly accepted, there's a [file](CONTRIBUTING.md) to know about some recommendations about the code of conduct, the process of commiting and accepting pull requests, along with some tips about code standards.

## Authors

* **Juan Gómez-Martinho González** - *[Juangmar](https://github.com/Juangmar)* -

## Contributors

Right now there are no contributors who participates regularly in this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details