Skip to content

Commit 07f2382

Browse files
authored
Merge pull request #3 from githubuniverseworkshops/arilivigni/repo-updates
Arilivigni/repo updates
2 parents dd15807 + d943225 commit 07f2382

File tree

6 files changed

+92
-18
lines changed

6 files changed

+92
-18
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@
44

55
Welcome to a custom Copilot workshop prepared by the **GitHub’s Expert Service team**!
66

7-
This workshop involves several technology stacks, therefore it is essential that you need to meet prerequisites as outlined in the prerequisites getting started if you want to follow along. Otherwise, you can always listen to what GitHub Expert Service team's instructor demo to see how it works in practice.
7+
This workshop involves several technology stacks, therefore it is essential that you need to meet prerequisites as outlined in the prerequisites getting started if you want to follow along. Otherwise, please follow along and listen to what the GitHub Expert Service team's instructor demo to see how it works in practice.
88

99
## Objectives and key takeaways
1010

1111
### Objectives
1212

1313
- Walk through a real-world use case:
14-
- Building a fitness app from end to end.
14+
- Building a fitness tracker app from end to end.
1515
- Create a full stack of technologies for the infrastructure, frontend, and backend.
16-
- Using the latest Copilot features.
16+
- Using the latest GitHub Copilot features.
1717

1818
### Key takeaways
1919

docs/1_Story/README.md

Lines changed: 78 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,84 @@
1-
# Story to develop a fitness application with GitHub Copilot now begins!
1+
# Your journey to develop a fitness tracker with GitHub Copilot now begins!
22

3-
![Story of Fitness application](../../images/octofitapp.png)
3+
![OctoFit Tracker](../../images/octofit-tracker.png)
44

5-
Fitness app “OctoFit Tracker” tracks the exercise on a personal level, competes with others (rank scoring), and suggests some fitness activities. This app has a beautiful interface that tracks the user’s fitness activities, login interface, and provides personalization options. It has a way to save that data in the backend, which can compete with other fitness buddies. The purpose of this app is to keep everyone motivated to login their activities within their own teams – there are several different teams within the app.
5+
Here's a reworked version of the workshop concept that's more suitable for a conference demo and attendee workshop:
66

7-
As the chief programmer, you are assigned to design this application in less than a week and show a POC to the CEO of the OctoFit Corporation. You were not sure what to do, but you heard about the great results of launching the applications ASAP through this thing called GitHub Copilot. You start building the application with technology stacks that you are familiar with. You decided to make it as a web application, though extensible later to mobile app, so you will use ReactJS for the front end, Python Django so we can leverage REST API as the backend, and MongoDB as the main database with possible in-memory data storage like Redis or Kafka. You also want to start testing out in a local environment, so Docker container will be good, but it will be later deployed to Microsoft Azure as the container app, and you want to automate the deployment through GitHub Actions in addition to leveraging something like Terraform.
7+
## OctoFit Tracker: Building a Fitness App with GitHub Copilot
8+
9+
Welcome to the OctoFit Tracker workshop! In this hands-on session, you'll step into the shoes of a lead developer tasked with creating a cutting-edge fitness tracker in record time. We'll leverage the power of GitHub Copilot to rapidly develop a functional prototype of OctoFit Tracker, a social fitness app that encourages users to stay active and compete with their peers.
10+
11+
### Workshop Overview
12+
13+
In this workshop, you'll:
14+
15+
1. Set up a development environment using GitHub Codespaces
16+
2. Use GitHub Copilot to accelerate development across multiple technologies
17+
3. Build key components of the OctoFit Tracker app
18+
4. Learn best practices for working with AI-assisted coding tools
19+
20+
### Application Features
21+
22+
OctoFit Tracker will include:
23+
24+
- User authentication and profiles
25+
- Activity logging and tracking
26+
- Team creation and management
27+
- Competitive leaderboards
28+
- Personalized workout suggestions
29+
30+
### Technology Stack
31+
32+
We'll be using a modern web application stack:
33+
34+
- **Frontend**: React.js
35+
- **Backend**: Python with Django REST Framework
36+
- **Database**: MongoDB
37+
- **Development Environment**: GitHub Codespaces
38+
39+
### Workshop Structure
40+
41+
1. **Introduction and Setup of prerequisites**
42+
- Overview of OctoFit Tracker concept
43+
- Setting up GitHub Codespaces
44+
45+
2. **Rapid Prototyping with GitHub Copilot**
46+
- Creating project structure
47+
- Generating boilerplate code
48+
- Implementing basic models and views
49+
50+
3. **Building Core Features**
51+
- User authentication
52+
- Activity logging API
53+
- Team management
54+
- Leaderboard functionality
55+
56+
4. **Frontend Development**
57+
- Setting up React components
58+
- Implementing responsive UI
59+
- Connecting to backend APIs
60+
61+
5. **Advanced Features and Optimization**
62+
- Adding personalized workout suggestions
63+
- Implementing caching with Redis
64+
- Optimizing database queries
65+
66+
6. **Wrap-up and Q&A**
67+
- Reviewing what we've built
68+
- Discussing best practices and lessons learned
69+
- Q&A session
70+
71+
### Key Takeaways
72+
73+
By the end of this workshop, attendees will:
74+
75+
- Gain hands-on experience with GitHub Copilot in a real-world scenario
76+
- Learn strategies for effective AI-assisted development
77+
- Understand how to leverage Copilot across different languages and frameworks
78+
- Develop a functional prototype of a modern web application
79+
80+
Join us for this exciting journey into the future of software development, where we'll harness the power of generative AI with GitHub Copilot to build OctoFit Tracker in record time!
881

982
In this workshop, you are going to assume to be the lead developer. You will be responsible for building the application with GitHub Copilot’s help. Good luck!
1083

11-
[Next: Prerequisites :soon:](../2_Prerequisites)
84+
[Next: Prerequisites, assumptions, and development environment setup](../2_Prerequisites)

docs/2_Prerequisites/README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,23 @@
1-
# Prerequisites, expectations, and assumptions
1+
# Prerequisites, assumptions, and development environment setup
22

3-
## Prerequisites for attendees
3+
## Prerequisites
44

5-
- GitHub Copilot license
6-
- Primary IDE: Visual Studio Code
7-
- Plugins installed
8-
- Operating System: Shouldn’t matter
9-
- GitHub Account
5+
- GitHub account
6+
- GitHub Copilot license
107

11-
## Technology stacks
8+
## OctoFit Tracker technology stack
129

1310
- NodeJS: Version xxx
1411
- ReactJS: Version xxx
1512
- Python Django: Version xxx
1613

17-
## Expectations
14+
## Developer environment setup
1815

19-
By the end of this guide, you will be expected to build a full stack application. However, due to some technical difficulties, it is likely that you will not be able to build everything in 40 minutes. However, you will still have a guide at the end to try on your own.
16+
### Go to the code tab
17+
![code tab](../../images/code-tab.png)
18+
19+
### Create a GitHub codespace
20+
![create a GitHub codespace](../../images/codespace-create.png)
2021

2122
## Assumptions
2223

images/code-tab.png

8.33 KB
Loading

images/codespace-create.png

50 KB
Loading
File renamed without changes.

0 commit comments

Comments
 (0)