Skip to content
This repository was archived by the owner on Oct 27, 2023. It is now read-only.

User Documentation

Peter Steele edited this page Dec 6, 2020 · 1 revision

Welcome to the User Documentation

This page was created to aid in using the program. If you have any questions, please feel free to reach out to me at info@pbsteele.com and I will be sure to answer those for you!

Getting Started

So to start using this application, you will need a Twitter account and have your username and password ready or be logged in. You will also need to start the application by clicking on the .exe to run it.

New User

You will be greeted by a screen asking if you are a returning user or a new user. Select new user if this is your first time running the application. You will select this option for each account you wish to sign into for the first time. Once you have selected the new user option, a new screen will appear with a Pin Code input box. You get the Pin Code by navigating to the internet browser window that was opened automatically for you, and copying the code into the input box. Once you have the code copied over, you can left click to the pin verification button and you will be logged into the app and your tweets will appear shortly.

Returning User

If you are a returning user, all you need to do is left click the returning user button and you will be taken to a new page that will ask for your Twitter screen name. This is the name that you @ on Twitter. Simply type in the name, minus the @ symbol, and press the login button. You will be redirected to the main page where your tweets will appear shortly.

Profile View and App Control

This is the first section that you will see on the far left side of the screen. This houses your profile information, such as your profile image, description, join date, and the amount of followers and how many people you follow. Below that, you will see 4 buttons. One for manually refreshing the feed and thus pulling in your Tweets from Twitter and the database, one for quitting the application, one for using MySQL as the main DB for the queries, and one for using MongoDB for the queries. I have this application setup in a way that uses both DB;s in the background to save and delete tweets, so they are always up to date with one another. The only difference is, that clicking these buttons will change which database you pull the saved tweets from to display on the main page.

Refresh Feed Button

The refresh feed button will go out, grab your tweets from Twitter, and save any new tweets to the Database while also grabbing those tweets from the database to update the tweets in the main feed section. This button is only needed if you manually tweet from Twitter directly and want to bring that tweet or tweets into the application without quitting the application and restarting it.

Quit App Button

Does what it says, asks if you would like to quit the application and if you select yes, it will close the application

Use MySQL Button

This button allows you to choose to use the remote MySQL database to pull in your saved tweets to the feed section.

Use MongoDB Button

This button allows you to choose to use the remote MongoDB database to pull in your saved tweets to the feed section. MongoDB is used by default.

Feed Section

This is the section that shows your tweets from newest to oldest. You will notice that it is built much like the Twitter website in regards to layout for the content. At this time, media is not supported, but will be implemented in a future release. You will see your profile picture, which is pulled from Twitter directly and thus will update if changed on Twitter, and then you have your account name and screen name. There is also a date of when the tweet was created and then the body of the tweet below that.

Tweet Section

The tweet section is the third and final section of the application. This allows you to post a text based tweet to Twitter directly from the application. It is limited to the 280 character limit that Twitter sets and will not let you type more than 280 characters in the text box. When you are ready to post your tweet, simply press the Tweet button and you will see a confirmation message appear. Press ok, and wait about 2-3 seconds and the feed section will automatically update to show the new tweet that was added to twitter. The new tweet is also automatically saved to both databases for retrieval afterwards.

Tweet Control Section

This is also in the Tweet Section below the option to post a new tweet. This section allows you to search your tweets, filter tweets by a date range, sort tweets starting with the oldest first, clear the constraints you might have set for searching, filtering, or sorting, and finally a button to delete tweets.

Search Tweets

To search your tweets for a specific word, type it into the search box and press the purple search button. You will see the feed section automatically update to reflect what tweets were found. If none are found, the feed section will be blank. There are some limitations to the search feature and it is limited to single words and simple phrases. Once you have searched a tweet or tweets, press the orange clear constraints button to reset all of the search, sort, and filter parameters and to reset the feed section back to showing all of the tweets again. You will do this anytime you search, sort, or filter to reset the feed section.

Filter by Date Range

So this allows you to input two dates and filter all of the tweets in between a date range. You can manually type in the dates (1/1/2020 in this format) or you can use the calendar picker option off to the right hand side of the date input box. The first date is the oldest date that you want to start from and the second date is the newest date you want to end on. Once you have selected your date range, press the purple filter button and you will see the feed section update to show the tweets that fall into that range. To reset the feed section, press the orange clear constraints button.

Oldest Tweets First

To sort the tweets by oldest first, left click the purple oldest tweets first button. This will update the feed section to show the oldest tweets first. This is especially handy when going back to delete old tweets that might be on your account. To reset the feed section back to normal with newest tweets showing first, press the orange clear constraints button.

Delete Tweets Button

To delete a tweet, simply left click any tweet in the feed section. You will see the tweet is highlighted and a different color than the rest. Head over to the Delete Tweet button and left click it to delete your tweet. You will get a confirmation box showing that the tweet was deleted. Press ok and after 2-3 seconds the feed section will update with the tweet deleted. The app will also automatically delete the tweet from both databases to keep them in sync with your live Twitter feed. Please note that deleting tweets are rate limited and you will not be able to mass delete tweets from your profile. This is Twitters limitation and there is nothing I can do about it unfortunately.

Conclusion

That about wraps up the user documentation at this point. As I continue to develop and work on this application, I will add more information here. Future releases should include media options, profile editing options, replying to tweets, viewing other peoples tweets, etc. My aim is to make a full desktop application that can do almost everything that you can do on the Twitter website. I hope you enjoy using my application and find it useful!