Skip to content

Latest commit

 

History

History
115 lines (82 loc) · 5.52 KB

README.md

File metadata and controls

115 lines (82 loc) · 5.52 KB
Raw

BirdsEye, A closer look at the bigger picture


javascript material-ui figma javascript javascript javascript visual code

Node.js CI License Build Status



What it does

BirdsEye lets you look at other simmilar tweets which can give you a sense of the other side of the topic. Most often than not in today's age people don't like to view the other persons side or even worse, never do get the chance to see the other side. BirdsEye combats this by notifiying the user about tweets that relates to the tweet he/she just sent. This can give the user a broader view of the topic or as we like to call it a Bird Eye's view 😉


Usage


Prototype



Developers

In order to run, use:

# Clone Repository
git clone https://github.com/Hackagroup/BirdsEye
cd BirdsEye

# Run Setup
bash setup.sh

IMPORTANT : React takes a while to start! Don't turn off in the middle of npm start.


Project Structure

Our project structure is as follows:

  • .github : Github related files.
    • workflows : Github Action Workflows
  • client : Frontend/Client-side code (ReactJS)
    • public : All public assets for react
    • src : Main frontend source code
      • actions : Types used for express/react comms
      • api : Twitter API used throughout app
      • assets : assets used in components/views for react
      • components : where all components are defined
      • constants : constants required throughout react
      • reducers : redux reducers
      • util : frontend dev utility
      • views : All the views of the app like /dashboard
  • public : Store images used in app and other services.
  • routes : Backend/Express routes
    • login: Authentication using twitter consumer api/sercret key
    • tweet: Searches for tweets and creates new tweets
    • user : Fetches user information using /:userid
  • utils : Utilities for devs.
  • .env(.example) :Enviorement variables for Twitter Consumer API's
  • .travis.yml : Travis-CI Configuration
  • package.json : All Node dependancies and scripts for testing & building
  • server.js : NodeJS Entry point
  • setup.sh: Shell file that aids for installing all dependancies, configuring environment and running app!

FAQ

  1. What is this project about? This project is baed on a Twitter hackathon Hack for good theme, we plan to give users motivational tweets. More description will be posted.

  2. What is this for? BirdsEye is for everyone looking for daily motivation to get through their life and get them ready to conquer the world!

  3. Need Help? Absolutely! Any help would be appreciated! To get to us, either request an issue or check ask a question: https://github.com/Hackagroup/Twitive/issues


License

BirdsEye is Licensed under the MIT License.