Requirements Specification - ftanrisevdi/swe573 GitHub Wiki

Requirements

1. Functional requirements:

1.1. Authenticate (register/login/logout)

1.1.1 As a User, I should be able to register with my email address.

1.1.2 Email address must be required.

1.1.3 As a user, I should be able to set my password to use my next possible visits.

1.1.4 As a user, I should be able to use my email address to login the system.

1.1.5 As a user, I should be able to logout from the system.

1.2 Search

1.2.1 System should have a search mechanism.

1.2.1.1 Search mechanism should have a textarea to insert the keyword which will be searched.

1.2.1.1.1 Keyword must be required.

1.2.1.2 Search mechanism should have a digit input to decide how many tweets will be collected at a time.

1.2.1.3 Search mechanism should have a submit button to start the search itself.

1.3 Show

1.3.1 As a user, I should be able to see the search results.

1.3.1.1 Search results should be shown with graphs.

1.3.1.2 Search results should be shown with sentiment analysis.

1.4 Log

1.4.1 As a user, I should be able to log my search results.

1.5 Provide

1.5.1 As a user, I should be able to see my history of previous logs(search results).

2. Non-Functional requirements:

2.1 Django and Python should be used for BE

2.2 Angular should be used for FE

2.3 PostgreSQL should be used for relational database needs.

2.4 TagMe should be used for entity linking.

2.5 Twitter API should be used for data source.

2.6 NLTK should be used for sentiment analysis