Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dockerize the Application #85

Merged
merged 6 commits into from
Jan 4, 2024
Merged

Conversation

mayura-andrew
Copy link
Member

@mayura-andrew mayura-andrew commented Jan 3, 2024

Purpose

The purpose of this PR is to fix #84

Goals

The main goal is to create a Dockerfile and docker-compose.yml file that will allow the backend to be built and run in a Docker container. This will ensure that all developers are working in the same environment, reducing the "it works on my machine" problem.

Approach

We will create a Dockerfile that describes the environment needed to run the backend, including the base image, necessary dependencies, and how to run the application. We will also create a docker-compose.yml file to manage the services our application needs, such as a database.

Screenshots

Screenshots are not applicable for this PR as it doesn't involve any UI changes.

Checklist

  • This PR doesn't commit any keys, passwords, tokens, usernames, or other secrets.
  • I have read and understood the development best practices guidelines ( http://bit.ly/sef-best-practices )
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation

##Related PRs
No related PRs.

Test environment

This feature was tested on Docker Desktop 4.26.1 and, build on Fedora Linux 39 (KDE Plasma) x86_64

Learning
During the implementation of this feature, I learned about Docker and its benefits in creating consistent development environments. I also learned how to use Docker Compose to manage multi-container applications.

Copy link
Member

@anjula-sack anjula-sack left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mayura-andrew Can you update the read me with how to use docker to run the project?

Dockerfile Outdated Show resolved Hide resolved
docker-compose.yml Outdated Show resolved Hide resolved
@anjula-sack
Copy link
Member

For the PR description can you use the following format @mayura-andrew

https://github.com/sef-global/scholarx-backend/blob/main/.github/pull_request_template.md

Copy link
Member Author

@mayura-andrew mayura-andrew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added new line

@anjula-sack
Copy link
Member

@mayura-andrew The purpose should be like the issue number. So the issue will be closed automatically when the PR is merged.

The purpose of this PR is to fix #84

@anjula-sack anjula-sack merged commit adc3a67 into sef-global:main Jan 4, 2024
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Dockerize the Application
2 participants