This project will serve as a guide on how to setup a three part application that includes a Spring server, a SQL database and a React frontend both locally and on a Kubernetes host.
To setup the project locally, you must have docker installed and running on your machine. Once it is setup, run the following command:
docker compose up
This will setup the app and you can access the following addresses on your browser:
- React frontend = http://localhost:3000
- Spring backend = http://localhost:8080/api (add /docs.html to access Swagger UI)
To run the tests for the Java and Python applications, run the following command:
make test
To only run the tests for the Python application, run the following command:
docker compose -f test.yml up --build python-test
To run the test for the Python application locally (without docker), run the following command (bs4, pytest, and pytest-cov need to be installed):
pytest --cov scraper
To only run the tests for the Java application, run the following command:
docker compose -f test.yml up --build spring-test
If the user does not have make installed on their computer, please run this instead:
docker compose -f test.yml up --build
The results of the Spring tests can be found in the spring-test-results folder in the root of the project directory after running the tests.
- Run
docker compose up --buildto rebuild the containers - When developing the MariaDB database remove the volumes to reset the database or your changes will not be reflected
docker compose down -v