Tweeter-Engine-Elixir-Phoenix

Team

Amrutha Alaparthy (6690-5246) & Meghana Madineni (9197-8425)

Run Instructions

Start the Phoenix Server
- Go to the directory of the project.
- Install dependencies with the command below.
  mix deps.get
- Install Node.js dependencies with the command below.
  cd assets && npm install
- Start Phoenix endpoint with the following instruction.
  mix phx.server
To Observe Tweeter Activity
- To open the application
  - Visit localhost:4000 from your browser.
- In Login and Register page
  - Enter the username and password of the user.
  - The user has to sign up first, in order to login.
- To Follow users
  - Once the user registers and is logged in, the user can follow other users by giving the username and clicking on the Follow button.
- To Tweet
  - To send the tweet, the user can enter the text and click the Tweet button.
  - Tweets can include hashtags or mentions.
  - This tweet is sent to the followers of the user and it gets displayed on their respective timelines.
- Retweet Activity
  - Once any user receives tweet, the user can re-tweet by clicking on the Retweet button, this functionality is same as that of tweet.
- Querying the tweets
  - The user can query for hashtags or mentions by entering it and clicking the Query button. This will list all the tweets which contains the particular hashtag or mention.
- To Logout
  - To logout, the user can click the Signout button.