Git Product home page Git Product logo

tweethunter's Introduction

Tweet Hunter

TweetHunter Codacy coverage Website

This application was made using Ruby on Rails 6 with a lot of nice gems!

To check the application working access: Tweet Hunter

Steps to run this project locally:

  1. [Dependencies] Check if you have installed Ruby 2.6.0, Bundler 2 (or greater), Node 8.16.0 (or greater), redis and postgres (check if these last two are running).

    You may want to install Ruby 2.6.0 using rvm as well Node 8.16.0 with nvm!

    • If you installed Ruby 2.6.0 using rvm, you may need to update Bundler with gem update --bundler

    • Install yarn from npm: sudo npm install --global yarn

    • You need to install a system package called libpqsomething. In Arch Linux is called libpqxx, in Ubuntu you may also install libpqxx-dev.

  2. Clone and cd this project.

    Always run the commands from the project folder!

  3. Run bundle install.

  4. Run figaro install.

  5. Insert your Twitter API credentials in config/application.yml, like so:

    consumer_key: XXXXXX
    consumer_secret: XXXXXXX
    access_token: XXXXXXXX
    access_secret: XXXXXXXX
    
  6. Create a database in postgres called tweet_hunter.

You may customize who is the user in config/database.yml, but you may also skip this!

  1. Run yarn install --check-files.

  2. Run rake db:migrate from the project folder.

  3. Run rake environment tweet_stream:start in another terminal.

  4. Run INTERVAL=0.1 QUEUE=* COUNT=2 rake environment resque:work in another terminal.

  5. Run rails s and check http://localhost:3000/ .

  6. Run tests with rspec.

A brief list of the tools used:

  • Ruby 2.6

  • Rails 6

  • CircleCI

  • Codacy

  • RSpec

  • Rubocop

  • Resque and Resque-scheduler (gems)

  • Solargraph (Language Server)

  • TreeTop (gem)

  • ActsAsParanoid (gem)

  • Twitter API (gem)

  • VCR (gem)

  • Bootstrap

  • Sorbet

  • Heroku

tweethunter's People

Contributors

rafaelcgs10 avatar dependabot[bot] avatar

Watchers

James Cloos avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.