Skip to content

euivanw/users_service

Repository files navigation

Users Service

Objective:

This service is responsible for managing users. It provides APIs to create, read, update, delete, and list users.

Key Technologies:

Creating the Docker image:

To create the Docker image, you need to have Docker installed on your system. Navigate to the root directory of the project and run the following command:

docker build -t users-service .

This command will create a Docker image named users-service from the Dockerfile in the root directory.

Generating version tags:

The project uses paulhatch/semantic-version@v5.4.0 GitHub Actions to automatically increment version numbers and generate tags.

It is necessary to ensure that the commit generated by the Pull Request to the main branch contains the prefix below according to the type of version being generated.

Prefix Type of increment Original version New version
(MAJOR) Major 1.0.0 2.0.0
(MINOR) Minor 1.0.0 1.1.0
LEAVE EMPTY Patch 1.0.0 1.0.1

Hint: Remember to update the version within pubspec.yaml file to the version that you'll generate before the generation.

Running the application with Docker:

Finally, run the following command in the root directory of the project:

docker compose up -d

This command will start a container from the users-service image, with all the necessary environment variables configured previously.

Development:

Made with ♥ by Ivan Wilhelm.

Coded in IntelliJ IDEA Community by JetBrains