Dividend Portfolio

Dividend Portfolio will be a multi-user web application built with Rails 8 that allows users to track their stock and ETF investments, record transactions, add dividends, and view statistics about their gains, losses, and dividends. The application also includes a radar feature where users can add stocks they are interested in and view basic stock information.

This is a pet project I will be working on.

Currently, it is in a very early stage, and many things may fail or not work at all.

• The first iteration will focus on authentication and retrieving basic stock information using different finance providers client gems.
• The second iteration is focusing on enabling each user to create their own radar and search, add or remove stocks.
• Next iterations to be defined.

• User Authentication: Secure user authentication using Rails 8 built-in authentication.
• Multiple Financial Data Providers: Choose the one that better fits your needs.
  • Yahoo client: yahoo_finance_client. Probably not working as Y! closed API
  • Alpha Vantage: alphavantage_ruby
• Portfolio Management: Track buys and sales of stocks and ETFs in your portfolio.
• Dividend Tracking: Add and manage dividends received from your investments.
• Statistics: View statistics about your gains, losses, and total dividends.
• Stock Data: Fetch stock data from reliable internet sources.
• Portfolio Overview: View your current portfolio with company logos and percentage allocation.
• Radar: Add stocks to your radar and view basic stock information such as payout, yield, P/E ratio, EPS, and stock price.

• Currently the application doesn't allow multiple currencies.

git clone https://github.com/yourusername/dividend-portfolio.git
cd dividend-portfolio

The application supports multiple financial data providers. Currently, you can use either Alpha Vantage or Yahoo Finance.

1. Using Alpha Vantage (Recommended)

   1. Get a free API key from Alpha Vantage
   2. Create a .env file in the project root:

   echo "ALPHAVANTAGE_API_KEY=your_api_key_here" > .env

   3. Configure the provider in config/initializers/financial_data_provider.rb:

   config.financial_data_provider = :alpha_vantage
   

2. Using Yahoo Finance

   Configure the provider in config/initializers/financial_data_provider.rb

   config.financial_data_provider = :yahoo_finance
   

   Note: The Yahoo Finance API might be unstable or have limitations. Alpha Vantage is recommended for more reliable data.

```
bundle install
```

```sh
rails db:create
rails db:migrate
rails db:seed
```

```sh
bin/dev
```

You will need foreman gem if it's not installed.

Open your web browser and go to http://localhost:3000.

You can sign in with the default user default@example and password as password.

The application uses RSpec for testing. To run the tests:

bundle exec rspec

For local development and testing, create a .env.test file:

ALPHAVANTAGE_API_KEY=dummy_key_for_tests

For GitHub Actions, add the following to your repository secrets:

1. Go to your repository settings
2. Navigate to Secrets and Variables > Actions
3. Add a new repository secret:
   • Name: ALPHAVANTAGE_API_KEY
   • Value: Your Alpha Vantage API key or a dummy key for tests

Note: Tests are configured to mock API calls, so you don't need a real API key for running tests.