Welcome to this repository where we dive into the world of Continuous Integration/Continuous Deployment (CI/CD) using CircleCI and Docker! 🐳 This repository is a beginner-friendly guide designed for those starting their journey in CI/CD and Docker. It's a great resource for learning, exploring, and contributing!
This repository contains a simple Flask web application. The main functionality of this app is to display a welcoming message "Welcome to my Flask App" on the home page. The application is straightforward, making it an excellent candidate for learning basic CI/CD and containerization concepts.
The repository includes the following key files:
Dockerfile: Defines the Docker container for the Flask app.main.py: The Flask application's main file.test_main.py: Contains tests for the Flask app.requirements.txt: Lists the necessary Python packages.
To get started with this project, you'll need a basic understanding of Python, Flask, Docker, and CI/CD principles. Here are the steps to follow:
- Fork and Clone: Fork this repository and clone it to your local machine.
- Docker Setup: Make sure you have Docker installed on your system. If not, download it from the Docker website.
- CircleCI Account: You'll need a CircleCI account, which you can set up here.
- DockerHub Account: DockerHub is required to store Docker images. Sign up if you haven't already.
Feel free to use this repository as a starting point for your CI/CD and Docker learning journey! Contributions are highly encouraged. If you have enhancements, bug fixes, or improvements, please submit a pull request. Your contributions will help make this a valuable resource for the community!
- Environment Variables: Set your DockerHub username and password as environment variables (
DOCKER_USERNAMEandDOCKER_PASSWORD) in your CircleCI project settings. - Customize and Test: Modify the application as needed and write tests.
- Push Your Changes: Commit and push your changes to trigger the CircleCI pipeline.
- Check Pipeline Results: Monitor the build results in CircleCI and ensure everything passes.
After setting up your CircleCI CI/CD Pipeline, it's time to get it up and running! Follow these steps to activate your pipeline:
- Access CircleCI: Log in to your CircleCI account using your GitHub credentials. You can do this through your web browser.
- Find Your Project: Go to the Projects tab on the left panel in CircleCI.
- Activate Pipeline: Click on the Set Up Project button next to your project. This action will activate the CircleCI pipeline for your project.
- Dashboard Check: Head back to the Dashboard tab. Here, you should see a "Success" status, indicating that your pipeline ran smoothly and the image has been pushed to Docker Hub.
- View Pipeline Details: Click on the build to see the detailed steps executed by CircleCI during the pipeline run.
- Docker Hub Verification: Finally, visit your Docker Hub repository. You should see the image that was pushed through the CircleCI pipeline.
By following these steps, you can effectively activate and monitor your CircleCI pipeline, ensuring a smooth CI/CD process for your Flask application.
Contributions make the open-source community an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
If you have any questions or need help, don't hesitate to reach out. Let's learn and grow together in this exciting world of CI/CD and Docker!
Happy Coding! 🎉