https://github.com/vic778/stock_app
this app is a simple investment portfolio management system that allows users to track their investments and view performance metrics. first of all the user should create an account, loggin in trougth the token and create a portfolio. the app has services to calculate the profit and lost, it has filter such as year and it can download the csv file
https://github.com/vic778/stock_app
cors devise jwt-token postgresql rspec rubocop ruby-on-rails third-party
Last synced: about 1 month ago
JSON representation
this app is a simple investment portfolio management system that allows users to track their investments and view performance metrics. first of all the user should create an account, loggin in trougth the token and create a portfolio. the app has services to calculate the profit and lost, it has filter such as year and it can download the csv file
- Host: GitHub
- URL: https://github.com/vic778/stock_app
- Owner: vic778
- Created: 2023-06-20T15:50:29.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-06-27T12:54:23.000Z (almost 3 years ago)
- Last Synced: 2025-02-23T14:15:02.056Z (over 1 year ago)
- Topics: cors, devise, jwt-token, postgresql, rspec, rubocop, ruby-on-rails, third-party
- Language: Ruby
- Homepage: https://github.com/vic778/stock_app_front
- Size: 2.07 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# STOCK APP
> This app is a simple investment portfolio management system that allows users to track their investments and view performance metrics. first of all the user should create an account, loggin in trougth the token and create a portfolio. the app has services to calculate the profit and lost, it has filter such as year and it can download the csv file. This API is made these models:
- User Model
- Portfolio
- Investment
### ERD PG
### Message rendered from the backend
### User confirmation Mailer
### Deployment
[Video](https://www.loom.com/share/25504df4e78a44d8b1a2d5caa4b71c98?sid=89cf883f-b4f1-4a6b-aa26-17878595dd0c)
## Built With
- Rails
- Ruby
- Postgresql
- Devise
- JWT
- Alpha Vantage
- ActiveRecord Serializer
- Sidekiq
- Redis
- Rspec
### Front-End
[Repo Link](https://github.com/vic778/stock_app_front)
## Endepoints
allow user to authenticate and return a token
`POST /api/users/login`
allows user to create an account
`POST /users/`
create a portfolio
`POST /api/portfolios/`
get a portfolio with investements
`GET /api/portfolios/:id`
crreate an investement
`POST /api/portfolios/:id/investments`
## Notice
all the calculations includes comments for formula are in the daily_report_service.
## Getting Started
Here are the steps to follow in order to get this project on your local computer.
### Prerequisites
`rails v7.0.2 +`
`ruby v3.1.2 +`
### Setup
clone this repo by typing `git clone https://github.com/vic778/stock_app`
### Install
install the dependencies by typing `bundle install`
### Usage
start the local server by running `rails s`
### Testing
run the tests by typing `rspec`
## Documentation
User Registration and Login:
Users can create an account by providing their details and registering.
- Once registered, users can log in to the application using their credentials.
- The login process generates a token that will be used for subsequent API calls.
Portfolio Creation:
- After logging in, users can create a new portfolio.
- They can provide a name and an optional description for the portfolio.
- Upon creation, the portfolio is associated with the logged-in user.
Investment Creation:
- Users can add investments to their portfolios.
- They need to provide details such as the security symbol or ticker, purchase price, number of shares, and purchase date.
- When creating an investment, the user selects the portfolio to which it belongs.
Profit and Loss Calculation:
- The application provides services to calculate the profit and loss of investments.
- It takes into account the purchase price, current market data, and the number of shares.
- The calculated profit and loss are displayed to the user.
Filtering and Historical Data:
- Users can filter their investments based on various criteria such as a specific year.
- The application fetches and displays the historical performance data for the selected investments.
- CSV File Download:
## Author
👤 **Victor Barh**
- GitHub: [@Vvic778](https://github.com/vic778)
- Twitter: [@victoirBarh](https://twitter.com/)
- LinkedIn: [LinkedIn](https://linkedin.com/in/victoir-barh)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check the [issues page](issues/).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
N/A
## 📝 License
This project is [MIT](lic.url) licensed.