Twitter Sentiment

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgements

About The Project

A mobile app that determines the sentiment (positive, negative, neutral) of a topic based on conversations happening on Twitter by leveraging natural language processing and machine learning.

Built With

• SwiftUI
• CoreML
• CreateML

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• Twitter Developers Account
• Twitter Account

Installation

1. Download or clone this repo

   $ git clone [email protected]:ellojess/Twitter-Sentiment-iOS.git

2. Get your free credentials from Twitter at https://developer.twitter.com/en/dashboard

   Use the credentials from the Developers Account to get the following values.

   Add them in the Constants.swift file by replacing VALUE with your personal credentials

   let apiKey="VALUE"
   let apiSecretKey="VALUE"
   let bearerToken="VALUE"
   

3. cd into the project folder and open it in Xcode (or use xed . to open it from terminal)

   $ cd Twitter-Sentiment
   
   $ xed . 

4. If your local project has an error with Swifter you can delete SwifteriOS from the file hierarchy

   Then download and embed SwifteriOS from here

Roadmap

See the open issues for a list of proposed features (and known issues).

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 using this template

Possible Contributions

• Add a new feature (accessibilities, etc.)
• New UI elements (animations, dark-mode, etc)
• Increase accuracy of model (handle sarcasm & emojis)

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Jessica Trinh - @ellojesss - [email protected]

Project Link: https://github.com/ellojess/Twitter-Sentiment-iOS

Acknowledgements

• Swift
• SwiftUI
• CoreML
• SwifteriOS
• SwiftyJSON
• Twitter Sanders Apple3 dataset