https://github.com/prajwalsrinvas/docker-mastery
https://github.com/prajwalsrinvas/docker-mastery
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/prajwalsrinvas/docker-mastery
- Owner: Prajwalsrinvas
- License: mpl-2.0
- Created: 2024-12-07T09:19:31.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-12-07T09:44:35.000Z (6 months ago)
- Last Synced: 2024-12-07T10:21:41.505Z (6 months ago)
- Language: Java
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docker Mastery
This project is intented to use with exercises for Docker Mastery course by tdevs.in.
## Environment Variables
This project uses below environment variables:
```shell
DB_URL #Example: jdbc:mysql://localhost:3306/dockermastery Syntax: jdbc:mysql://:/
DB_USERNAME # Username of databases Example: root
DB_PASSWORD # Password of database Example: root12345
```
Make sure your DB is up and running and an empty database is created.
For example, if you have a mysql instance running locally at port 3306, connect to it and create a new database schema using below command:
```sql
CREATE DATABASE dockermastery;
```
The DB URL will become `jdbc:mysql://localhost:3306/dockermastery`
## Build Steps
This project uses JAVA 21 and Maven. Make sure you have that installed in the system.
This project has an inbuilt Maven wrapper `mvnw` that can be used to build, test, and run the project.
To Run this project, below command can be used:
```shell
./mvnw spring-boot:run
```
or
```shell
mvn spring-boot:run
```
The Run will fail if above environment variables are not set.
You can pass these environment variables as below:
On linux/macOs
```shell
export DB_URL="jdbc:mysql://localhost:3306/dockermastery"
export DB_USERNAME=root
export DB_PASSWORD=root
```
On Windows:
```batch
set DB_URL=jdbc:mysql://localhost:3306/dockermastery
set DB_USERNAME=root
set DB_PASSWORD=root
```
As the application starts, it creates a table called `todo` and add a few rows to it.
The application runs at port `8080`
Once the application is started, you can go to your browser and go to url `http://localhost:8080/`. This will return the following response on your browser:
```json
{
"todos": [
{
"id": 1,
"title": "Finish Assignment",
"description": "Complete the assignment on database management systems.",
"status": "pending"
},
{
"id": 2,
"title": "Grocery Shopping",
"description": "Buy milk, eggs, and bread from the supermarket.",
"status": "completed"
}
]
}
```
If you are getting this output, your application is running correctly.
## Packaging
Application can be compiled and packed in a jar using the below command:
```shell
./mvnw clean package
```
This command outputs the jar inside `target` folder with name `dockermastery-0.0.1-SNAPSHOT.jar`.
To run this jar, you can use below command:
```shell
java -jar dockermastery-0.0.1-SNAPSHOT.jar
```
Make sure your environment variables are set before running this jar.
## Running tests
This application contains unit tests that can be run by
```shell
./mvnw test
```
Make sure all tests are passed before running the application.