Giter Club home page Giter Club logo

fiver's Introduction

README

Fiver

See The Active Site:

Fiver

Pitch: This app searches Twitter based on search parameters that the user provides it. The user then has the opportunity to fetch both a tone analysis of the tweets, and then also put in a call to a Cryptocurrency API that will fetch the current market status of that currency.

Tech Pitch: I built this project to push my boundaries in a number of areas. It was the first project where I managed the entire project scope and the architecture. It was also used to push my usage of consuming both internal and external API's further. It also was a small exercise in manually building serializers in POROs and passing that to the internal API point with only the desired information. I also took the opportunity to build out some API requests using the JavaScript fetch API.

For the future I'd like to refactor this into solely backend API endpoints and have a seperate APP that consumes those endpoints. I would also like to build rake tasks to run at certain times and then push the data to a service like Redis in order to speed up the API calls.

screenshot

Table Of Contents

Versions/Prerequisites


Main:

To Install and run this application please be aware of the following versions and requirements:

  • Postgresql 10+
  • Rails 5+
  • Ruby 2.4+
  • Node.js
  • JQuery
Secondary:
  • ActiveRecord
  • ActiveModelSerializers
  • PG
  • Puma

Setup


  • First clone down this repository and change directory into the project directory:
git clone https://github.com/nergdnvlt/fiver.git
cd fiver
  • Then in your command line run bundle to install the gem dependencies:
bundle
  • Now setup your database and run the migrations to properly set up your database tables:
rake db:create
rake db:migrate
  • It's now time to seed the database with the required data:
rake db:seed
  • At this point the project is set up. Explore at will.

The Test Suite


Test Information

Test Suite Components:
  • DatabaseCleaner
  • FactoryBot
  • Rspec
  • ShouldaMatchers

Test Documentation and Tweaks

  • For additional documentation and the individual tests as the suite runs:
--format=documentation
  • Additional Useful Flags:
--order=random
--color
About The Tests:

The test suite includes test for the following:

  • Model Level Testing
  • Feature Testing
  • Service Testing
  • Presenter Testing These tests can be found in the following folder:
spec/models/
spec/features/
spec/services/
spec/presenters
Running The Suite:
  • In order to run the test suite, from the root project folder simply run:
rspec

Spinning Up a Server


  • Next spin up your server:
rails s

Authors

fiver's People

Contributors

tlvndgren 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.