search

Aadarsh805 / TweetSage

What your tweets tell about you? Get personalized answers to your questions based on your recent tweets. Our website analyzes your Twitter activity to provide you with accurate and relevant responses to your queries
https://tweet-sage.vercel.app
MIT License
52 stars 14 forks source link
material-ui nextjs nextjs13 openai reactjs tailwindcss twitter twitter-api typescript

readme

TweetSage

"Not being maintained currently"

An open-source tool that analyzes your Twitter activity and answers to your questions based on your recent tweets

Wanna know more how it's built, check out my blog on how I built it: BLOG LINK

https://user-images.githubusercontent.com/95094057/208742885-50db694c-1b8d-4aa4-bbc7-22ac8e932044.mp4

How it works

Installation

This project is built on nextJS 13 experimental version

  1. Fork the repo into your account

Fork Image

  1. Clone the project into your local machine
git clone https://github.com/<Your-name>/TweetSage.git
  1. Navigate the folder
cd TweetSage
  1. Install the dependencies
npm install
  1. Make .env file in root directory with these variables
BearerToken= 'YOUR TWITTER API KEY GOES HERE'
OPEN_API_KEY= 'YOUR OPENAI API KEY GOES HERE'
  1. Run the project on local machine
npm run dev
  1. Every time you start making changes to your forked repo make sure it's in sync with the original repo

Contributing Guidelines

Thank you for considering to contribute to this project.

What do I need to know to contribute?

This project is in a very early stage so anybody who's familiar with ReactJS/NextJS/Typescript/TailwindCSS can contribute. If you don't feel ready to make a contribution yet, no problem at all. You can also contribute to this ReadMe section or the Documentation part of our project.

If you are interested to contribute and want to learn more about the technologies that are used in this project, checkout the links below.

How to make a Contribution?

Never made an open source contribution before? And wondering how to contribute to this project? No worries! Here's a quick guide,

  1. Choose any feature/bug you wish to contribute to.
  2. Fork the repository into your own account.
  3. Clone the repo you have forked in your local machine using git clone https://github.com/<Your-name>/TweetSage.git
  4. Create a new branch for your fix by using the command git checkout -b YourName-branch-name
  5. Make the changes you wish to do and stage them using the command git add files-you-have-changed or use git add .
  6. Use the command git commit -m "Short description of the changes" to describe the changes you have done with a message.
  7. Push the changes to your remote repository using git push origin your-branch-name
  8. Submit a PR(pull request) to the upstream repository Aadarsh805/TweeetSage with a title and a small description.
  9. Wait for the pull request to be reviewed by us.
  10. Make appropriate changes if the maintainer recommends you to and submit it.
  11. Await for your contribution to be merged into the repository.

Checkout the Contributing.md file before contributing.

Where can I go for help?

If you need help, you can ask questions on our twitter :

Credits

License

MIT

Thanks to all the Contributors ❤️

Your Support means a lot

Give a ⭐ to the project if you liked it. :)