-
Goal: Learn about GitHub Actions and create examples and apply them in your future projects. At the end of the week, you should be familiar with GitHub Actions and specifically its Continious Deployment (CD) part.
-
Dates: from 8th to 13th February
-
Where:
#project-of-the-weekin DataTalks.Club (get in slack here: https://datatalks.club/slack.html)
For more information about the "Project of the Week" initiative at DataTalks.Club, see README.md.
If you want to receive reminders about this event, sign up here
- Github
- Docker
- Flask,FAST-API
- Unit testing,linting and formating libraries
Note: this is a suggested list of technologies, you can chose alternatives instead
This is a proposed plan only, you don’t have to follow it day-by-day.
- Create a GitHub repository.
- Refresh basic concepts from the suggested material.
- Study the concepts behind Continious Deployment in GitHub Actions tutorial.
- Share your progress in Slack and on social media.
Suggested material:
Found good materials? Create a PR with links!
- Build a service (Flask or FastAPI) from your Part 1 project. You can copy and run/test the suggested material tutorial.
- If you dont have a project, you can select this example from FAST-API project of the week by Liliana.
- Also, If you want to create your project from scratch, you can select a dataset from the list bellow.
- Commit your changes.
- Share your progress in Slack and on social media.
Suggested material:
- 📺 Flask tutoria
- 📺 Fast-API tutorial (check the FAST-API app part)
- 💻 FAST-API sample project
- 💾 list of some datasets
Found good materials? Create a PR with links!
- Prepare a runnable dockerfile of your app.
- Include an integration test. You can create a docker-compose yaml and include it like the MLops video course suggests.
- Commit your changes.
- Share your progress in Slack and on social media.
Suggested material:
- 📺 Dockerizing web app (Fast API) video 1
- 📺 Dockerizing web app (Fast API) video 2
- 📺 Dockerizing web app (Flask))
- 💻 Integration script example:
- 🏫 Integration test tutorial: DataTalksClub MLops Course
Found good materials? Create a PR with links!
- Finish dockerizing and the integration test.
- Edit the Github workflow to run the image and the integration test. (Now when you make a change to the image it will run a new one).
- Commit your changes.
- Share your progress in Slack and on social media.
Suggested material:
- 🗒️ Github Actions creating docker container
- 🏫 Integration test tutorial: DataTalksClub MLops Course
- 💻 Example workflow
Found good materials? Create a PR with links!
- Edit the workflow so that pushed the image to your private docker repository https://hub.docker.com/. Make sure you dont publish your secrets (username and password!).
- Commit your changes.
- Share your progress in Slack and on social media.
Suggested material:
- 📺 Github Actions Tutorial (check the last part of the video)
- 💻 Example script for pushing to private docker repo
Found good materials? Create a PR with links!
- Study how you can deploy your service to a cloud provider (Heroku, AWS,Google cloud, Azure).
- Continue exploring more about this topic.
- Polish the documentation for your project.
- Push your changes to GitHub.
- Share your progress in Slack and on social media.
- Give us feedback.
- Add the link to your project to this project of the week GitHub page.
Suggested material:
Found good materials? Create a PR with links!
Datasets
Materials legend:
- 🏫 Course
- 💾 Dataset
- 🗒️ Article
- 📺 Video tutorial
- 💻 Code
List of projects from our participants:
- Project link 1
- Project link 2
- ...
- (Create a PR)
(We will put the projects here after the event finishes)