haron-iv / retwiter

Retwiter

Retwiter is the node application that let you automatize retwitting posts.
Explore the docs »

· Report Bug ·

Table of Contents

• About the Project
  • Built With
• Requirements
• Installation
• Contributing

About The Project

Retwiter is the node application that lets you automatize retwitting post from your account. The Retwiter application will get posts to retwitt from your following list. So you have to have at least one profile that you follow. You can run this application locally on your computer or on the VPS server. Application has a log system - if you want to read more about this section or other features go to the documentation of this project -> Retwiter wiki

Built With

• Nodejs
• puppeteer
• watchjs
• winston
• mongoose
• mongodb
• dotenv

Requirements

• Node v14.10.0
• npm 6.14.8

Installation

1. clone this repo

git clone https://github.com/venglas/retwiter.git

2. Install npm packages

npm i

3. If you have not installed mongo yet just run

Database have to be created at first call, but if it will not works create it by yourself, You can find instrunction in docs -> Retwiter wiki

sh isntall-and-start-mongo.sh

4. For VPS server with Ubuntu 18.04 LTS you have to install mising packages

sh missing-ubuntu-packages.sh

5. Copy .env-template configuration file into project root and change name of the file to '.env'. Fill this file with your credentials. Description of this and other steps you can find in project wiki: Retwiter wiki
6. Run application using node

node index.js

Contributing

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.

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