Dividend Tool is a Spring Boot application designed to help users manage their stock portfolios and track dividend income. The application scrapes dividend data from the Nasdaq website and allows users to manage their portfolios, holdings, and buy/sell operations.
- Scrape dividend data from the Nasdaq website for stocks in users' portfolios
- Manage users, portfolios, holdings, and buy/sell operations
- Generate reports of dividend income at specific points in time based on holdings and scraped dividend data
- Spring Boot
- Spring MVC Rest
- Spring HATEOAS
- Spring Data JPA
- Lombok
- PostgresSQL
- Gradle
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- JDK 11 or higher
- PostgresSQL
- Clone the repository:
git clone https://github.com/yourusername/dividend-tool.git
- Change into the project directory:
cd dividend-tool
- Update
application.propertieswith your PostgresSQL credentials and database URL:
spring.datasource.url=jdbc:postgresql://localhost:5432/your_database
spring.datasource.username=your_username
spring.datasource.password=your_password
- Build the project:
./gradlew build
- Run the application:
./gradlew bootRun
The application should now be running on http://localhost:8080.
Once the application is running, you can interact with the REST API to create, read, update, and delete users, portfolios, holdings, and buy/sell operations. The dividend data scraping service will automatically collect dividend data from the Nasdaq website for the stocks in users' portfolios.
To run the entire stack (backend, frontend, and PostgreSQL), use Docker Compose.
Navigate to the root directory of your project.
Generate the back-end jar:
gradle -p back-end clean build
Run the Docker Compose command to build and start the containers, specifying the docker-compose.yml file location:
For Linux/macOS:
docker-compose up --build
For Windows:
docker-compose up --build
- Docker
- Docker Compose