Skip to content

mdb571/threadunni

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

87 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BFH Banner

Threadunni

Open source web app and twitter bot that lets you read threads more easily and document them

GitHub

How it works ?

  • User tags @threadunni bot under the thread to be saved
  • Threadunni fetches the thread using twitter api and saves it in the dashboard as a blog post (usually takes about 3 minutes for the bot to reply)
  • User logins to the dashboard using twitter and can view his saved threads or download them as a PDF document

Features

  • Pull tagged threads from twitter using twitter API
  • Read and Save threads as a blog post
  • Download threads as a PDF
  • Social Login Using Twitter

Libraries used

Frontend

  • react : 17.0.2
  • jspdf : 2.3.1 (for pdf generation)
  • axios : 0.21.1 (api calls)

Backend

  • djangorestframework : 3.12.4
  • tweepy : 3.10.0

Refer package.json and requirements.txt respectively for more details

Setup

Frontend

  • Install the required npm packages with npm install
  • Start development server yarn start or react-scripts start Open http://localhost:3000 to view it in the browser.
  • Build with yarn build Builds the app for production to the build folder

Backend

  • Export the Keys list in .env
  • Install the required python libraries pip install -r requirements.txt
  • Run the bot with python manage.py bot
  • run the server with python manage.py runserver
  • Now you can start sending requests from the frontend to the backend API

live demo

Screenshots

Homepage

home

Profile
login

Thread
thread

Document (PDF)

document

Bot in action !

bot

Contributing and Support

Feel free to open a pull request if you can help in improving this project.

Credits

Show your support

Give a ⭐️ if this project helped you!❤️

Licence

Code released under the GPL.