https://github.com/wilyj80/jdbctemplate-compose

Raw SQL REST API with Spring Boot + Docker Compose + MariaDB + JDBCTemplate
https://github.com/wilyj80/jdbctemplate-compose

docker-compose jdbc jdbctemplate mariadb spring-boot

Last synced: about 2 months ago
JSON representation

Raw SQL REST API with Spring Boot + Docker Compose + MariaDB + JDBCTemplate

• Host: GitHub
• URL: https://github.com/wilyj80/jdbctemplate-compose
• Owner: wilyJ80
• Created: 2024-08-17T16:32:32.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-08-21T13:57:25.000Z (6 months ago)
• Last Synced: 2024-12-30T21:44:50.037Z (about 2 months ago)
• Topics: docker-compose, jdbc, jdbctemplate, mariadb, spring-boot
• Language: Java
• Homepage:
• Size: 23.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Requirements:

- Docker, Docker Compose

# Usage:

> [!TIP]

> 

> Create a .env file by renaming [example-env.md](example-env.md), then run

>

> `sudo docker compose up --build`

- No need to manually compile. Just run the container, because it compiles and runs.

   - Person endpoint: `http://localhost:8089/person`, supporting GET and POST (name parameter)

        - Database in `http://localhost:3366`

# Customizing for your project:

- Change ports in [docker-compose.yml](./docker-compose.yml) as desired.

- Change root password in `.env` as desired.

- [schema.sql](./src/main/resources/schema.sql) is the entrypoint database script. Change as desired.

    - If done, you will also want to change the example project Java source files (entities, endpoints...)

# TODO:

- [X] Return Person object instead of person name .-.

- [ ] Adminer database web UI

- [ ] Add more features and endpoints to example project

- [ ] Do not login to the database as root?

    - [ ] Add database users?

- [ ] Add view?

    - [ ] Static and templates?

- [ ] Add tests?

- [ ] Deploy?

- [ ] Remove Autowired?

- [X] try catch in the service layer?

- [X] change application.properties url?

- [ ] lists vs hashmaps

# Things I learned:

- It might be good to map your container ports to your machine ports that might be not in use. Try unconventional port numbers. Had issues with 8080 and 3306, which already were in use in my machine.

- Docker Compose is really your best option if you want a database or other extra services. Tried a single Dockerfile, sucked.

- Make sure you database script is not messed up! And remember, if there was a JDBC connection error, that probably means a database setup error, not error in your code. Check the Dockerfile, docker-compose.yml, application.properties, .env and schema.sql. Maybe your pom.xml too, just in case 🙈 ...

- Had problems with any example env file that started with .env or env. The project required a single .env in the project directory, forcing me to name the example .env as example-env.md

- It might be good to actually build your project inside the container. It isolates your project in a neat way for other people.