Giter Club home page Giter Club logo

returner's Introduction

Returner

Returner is a sample Elixir/Phoenix project that shows the past year returns for a bundle of stocks.

Installation

  • Clone the repo
  • Sign up for an Alpha Vantage API key
  • Create config/test.secret.exs and config/dev.secret.exs using the API key and samples
  • Install dependencies with mix deps.get
  • Install Node.js dependencies with cd assets && npm install
  • Start Phoenix endpoint with mix phx.server

Now you can visit localhost:4000 from your browser.

Architecture

  • Returner exposes a simple API -- fetch_returns/0.
    • On app startup, Returner fetches the returns for the past year and caches them
  • ReturnerWeb handles web requests

Testing

  • By default the test suite doesn't run any tests that query the Alpha Vantage API
  • To run external tests, do mix test --include external

Limitations

  • The Alpha Vantage API's free plan is rate-limited to five requests per minute

TODO

  • Update the returns cache with new returns every evening after market close.
  • Cache the returns in an external database or memory store, so that they aren't lost when the app shuts down
  • Create a deployment strategy

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.