Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 2.07 KB

README.md

File metadata and controls

41 lines (32 loc) · 2.07 KB
Raw

Baltic Stocks

https://laane.xyz/stonks

Java + React app that aggregates stock data from Baltic exchanges and concisely displays them in a single page. Updated daily.

GitHub Actions - Frontend GitHub Actions - Backend MIT license

Tools

Baltic Stocks uses Java and MariaDB for its backend and React and TypeScript for the frontend. Deployment is automated using GitHub Actions and AWS. The deployed backend is containerized using Docker.

Development

To locally run this you need Java, NodeJS, Docker + Docker Compose or MariaDB, Gradle (optional).

Backend

The following instructions use server as their root directory

  1. Run docker compose up in docker/dev/docker-compose.yml to start a preconfigured database in a Docker container. Alternatively set up the database manually using MariaDB.
  2. Insert sample data to DB from data directory .sql files
  3. Start the backend using gradle bootRun (local Gradle installation) or ./gradlew bootRun (macOS, Linux) or gradlew.bat bootRun (Windows)

Frontend

The following instructions use client as their root directory

  1. Install necessary dependencies with npm install
  2. Run the frontend application with npm start

Contributing and Issues

Contributions are always welcome. Anyone can open issues and pull requests on GitHub

License

This project is licensed under the MIT license