Home

Turing Tweets

Project Summary: We will parse in all the tweets from a specific user and use NLP to generate a new, fake tweet. The tweet will then be displayed alongside a real tweet on a web page, and the user will be prompted to choose which one they believe is real. Once they make a selection, the correct answer and the incorrect answer are appropriately highlighted.

git Workflow Summary: We will be a following a feature branch git workflow. At stand-up each day, the day's issues will be identified and populated onto GitHub issues. Group members will then pair program all functional elements of the web app. Workflow will follow a path where each pair will check out to an appropriately feature-named branch, merge from there to the "testing" branch, and only once all tests pass will "testing" be merged with "master" for deployment. After each deployment, the issues on GitHub issues will be reevaluated, and they will be closed out, edited, or replaced as necessary. The "master" branch will be kept deployment ready at all times.

git Workflow (Detailed)

1. After completing your last merge, review as a group the issues available on GitHub issues for our repo. Select an issue for you and your partner to work.
2. Clone the repo (if it does not already exist on your computer) git clone git@github.com:jjfeore/turingtweets.git
3. Checkout into a new branch with a name appropriate for the feature you are working on. git checkout -b featurename
4. After completing any substantial amount of work, the changes should be saved by A-C-Ping to the feature branch. git add files-changed git commit -m "Descriptive commit message" git push origin featurename
5. Approximately every 3 hours, the group should reconvene to discuss each pair's progress. If a group has finished work on an issue and completed tests for it, the issue will be review as a group and merge to the "testing" branch. Merges will be handled via the GitHub website, and all merge conflicts will be reviewed as a group.
6. If your group is not complete, continue working on the feature until it is finished and thoroughly tested.
7. Once all issues have been merged to "testing" and testing is completed, the group will meet to approve a push to master.
8. Reconvene and distribute issues again. If no issues remain, add issues from the pool of stretch goals.

User Stories:

• As a developer, I want to use the pyramid framework in order to scaffold this project. (2 hrs)
• As a group member, I want to establish a workflow that allows for all group members to be actively involved, so that we can save time in the long run. (0.5 hrs)
• As a developer, I want to authenticate with Twitter so that I can make all the requests necessary. (3 hrs)
• As a developer, I want to interact with the Twitter API so that I can scrape tweet data. (2 hrs)
• As a developer, I want to parse in all of a specified user's tweets so that I can process them. (1 hr)
• As a developer, I want to build a database of the parsed tweets in order to persist it. (1 hr)
• As a developer, I want to process my database with NLP so that I can generate new, fake tweets. (4 hrs)
• As a developer, I want to display a real and a fake tweet to the page so that I can present the user with a choice. (1.5 hrs)
• As a developer, I want to have a team page so that I can receive credit for my work. (1 hr)
• As a developer, I want to build an attractive web app to encourage more people to use it. (4 hrs)
• As a developer, I want to test all my code so that I know it works. (8 hrs)
• As a user, I want use a web app with responsive design, so that I can easily view the app on any device. (2 hrs)
• As a user, I want feedback on my selection, so that I know whether or not I was correct. (1 hr)
• As a user, I want a minimalist, uncluttered design, so that I can focus on the content of the web app. (0 hrs - Covered in dev stories)
• As a user, I want to be able to reset the page without refreshing so that I can continue to play. (2 hrs)