Skip to content

Commit d45ed04

Browse files
authored
Merge pull request #12 from githubuniverseworkshops/update-grammar-and-content
Update grammar and content
2 parents 0faf55a + f2c9512 commit d45ed04

File tree

3 files changed

+42
-25
lines changed

3 files changed

+42
-25
lines changed

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,36 @@
22

33
![Story of Fitness application](images/cover.jpg)
44

5-
Welcome to a custom Copilot workshop prepared by the **GitHub’s Expert Service team**!
5+
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, please follow along and listen to what the 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 the GitHub Expert Service team's instructor demo to see how it works in practice.
8+
9+
> :blue_book: **NOTE**: This workshop will be conducted through **Codespace**, but you can find a full step-by-step self-paced guide that you can try later without Codespace:
10+
[**gh.io/octofit-tutorial**](https://gh.io/octofit-tutorial)
811

912
## Objectives and key takeaways
1013

1114
### Objectives
1215

13-
- Walk through a real-world use case:
14-
- Building a fitness tracker app from end to end.
15-
- Create a full stack of technologies for the infrastructure, frontend, and backend.
16-
- Using the latest GitHub Copilot features.
16+
**Walk through a real-world use case**:
17+
- Building a fitness tracker app from end to end
18+
- Create a full stack of technologies for the infrastructure, frontend, and backend
19+
- Using the latest **GitHub Copilot** features
1720

1821
### Key takeaways
1922

20-
- Build a full stack application with GitHub Copilot using exercises and instructions that you can take with you
21-
- Experience the coolest, latest GitHub Copilot features, including Copilot and Copilot Chat
22-
- Learn different concepts in GitHub Copilot and best practices for effectively leveraging Copilot in a variety of scenarios
23+
- Build a full stack application with **GitHub Copilot** using exercises and instructions that you can take with you
24+
- Experience the coolest, latest GitHub Copilot features, including **Copilot** and **Copilot Chat**
25+
- Learn different concepts in **GitHub Copilot** and best practices for effectively leveraging **Copilot** in a variety of scenarios
2326

2427
Without further ado, let's get started.
2528

2629
## Table of Contents
2730

2831
1. [The OctoFit Tracker app story](docs/1_Story/README.md)
29-
2. [Prerequisites and asetup of the development environment](docs/2_Prerequisites/README.md)
32+
2. [Prerequisites and a setup of the development environment](docs/2_Prerequisites/README.md)
3033
3. [Getting started - app frontend and backend creation](docs/3_GettingStarted/README.md)
3134
4. [The OctoFit Tracker database and app backend creation](docs/4_BackendSettings/README.md)
3235
5. [Populate the database with sample data](docs/5_PopulateDBwData/README.md)
3336
6. [Using the Codespace endpoint to access the Django REST Framework](docs/6_CodespaceDjangoRESTFramework/README.md)
37+
7. [:fire: REFERENCE - Troubleshooting guide and FAQs](docs/7_Troubleshooting/README.md)

docs/1_Story/README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,27 @@
44

55
## OctoFit Tracker: Building a Fitness App with GitHub Copilot
66

7-
Welcome to the OctoFit Tracker app workshop! In this hands-on session, you'll step into the shoes of a lead developer tasked with creating a cutting-edge fitness tracker app 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.
7+
Welcome to the **OctoFit Tracker** app workshop! In this hands-on session, you'll step into the shoes of a lead developer tasked with creating a cutting-edge fitness tracker app 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 to compete with their peers.
88

99
### Workshop Overview
1010

1111
In this workshop, you'll:
1212

13-
1. Set up a development environment using GitHub Codespaces
14-
2. Use GitHub Copilot to accelerate development across multiple technologies
15-
3. Build key components of the OctoFit Tracker app
16-
4. Learn best practices and prompting techniques for working with GitHub Copilot
13+
1. Set up a development environment using **GitHub Codespaces**
14+
2. Use **GitHub Copilot** to accelerate development across multiple technologies
15+
3. Build key components of the **OctoFit Tracker** app
16+
4. Learn best practices and prompting techniques for working with **GitHub Copilot**
17+
18+
> :blue_book: **NOTE**: Because we have only 20 minutes for the actual workshop, it is possible that we cannot complete everything. However, we will have the value of troubleshooting together, and there is also a [self-paced exercise](https://gh.io/octofit-tutorial) if you want to follow along later.
1719
1820
### Application Features
1921

20-
OctoFit Tracker will include:
22+
**OctoFit Tracker** will include:
2123

2224
- User authentication and profiles
2325
- Activity logging and tracking
2426
- Team creation and management
25-
- Competitive leader boards
27+
- Competitive leaderboards
2628
- Personalized workout suggestions
2729

2830
### GitHub Copilot and Copilot Chat
@@ -40,7 +42,7 @@ OpenAI gpt-4o: *"Our high-intelligence flagship model for complex, multi-step ta
4042
- [How to use GitHub Copilot: Prompts, tips, and use cases](https://github.blog/2023-06-20-how-to-write-better-prompts-for-github-copilot/)
4143
- [Using GitHub Copilot in your IDE: Tips, tricks, and best practices](https://github.blog/2024-03-25-how-to-use-github-copilot-in-your-ide-tips-tricks-and-best-practices/)
4244
- [A developer’s guide to prompt engineering and LLMs](https://docs.github.com/en/copilot/using-github-copilot/prompt-engineering-for-github-copilot#:~:text=A%20developer%E2%80%99s%20guide%20to%20prompt%20engineering%20and%20LLMs)
43-
- [Prompting GitHub Copilot Chat to become your personal AI assistant for accessibility]https://github.blog/2023-10-09-prompting-github-copilot-chat-to-become-your-personal-ai-assistant-for-accessibility/()
45+
- [Prompting GitHub Copilot Chat to become your personal AI assistant for accessibility](https://github.blog/2023-10-09-prompting-github-copilot-chat-to-become-your-personal-ai-assistant-for-accessibility/)
4446

4547
OpenAI gpt-4o: *"Our high-intelligence flagship model for complex, multi-step tasks. GPT-4o is cheaper and faster than GPT-4 Turbo. Currently points to gpt-4o-2024-08-06"*
4648

@@ -61,32 +63,32 @@ We'll be using a modern web application stack:
6163
- Overview of OctoFit Tracker app concept
6264
- OpenAI GPT models
6365

64-
1. **Setup of Prerequisites**
66+
2. **Setup of Prerequisites**
6567
- Setting up GitHub Codespaces
6668
- Ensure GitHub Copilot and Copilot Chat extensions are up to date
6769

68-
1. **Rapid Prototyping with GitHub Copilot**
70+
3. **Rapid Prototyping with GitHub Copilot**
6971
- Creating project structure
7072
- Generating boilerplate code
7173
- Implementing basic models, serializers, urls, and views
7274

73-
1. **Building Core Features**
75+
4. **Building Core Features**
7476
- User authentication
7577
- Activity logging API
7678
- Team management
7779
- Leader board functionality
7880

79-
1. **Frontend Development**
81+
5. **Frontend Development**
8082
- Setting up React components
8183
- Implementing responsive UI
8284
- Connecting to backend APIs
8385

84-
1. **Advanced Features and Optimization**
86+
6. **Advanced Features and Optimization**
8587
- Adding personalized workout suggestions
8688
- Implementing caching with Redis
8789
- Optimizing database queries
8890

89-
1. **Wrap-up and Q&A**
91+
7. **Wrap-up and Q&A**
9092
- Reviewing what we've built
9193
- Discussing best practices and lessons learned
9294
- Q&A session
@@ -95,7 +97,7 @@ We'll be using a modern web application stack:
9597

9698
By the end of this workshop, attendees will:
9799

98-
- Gain hands-on experience with GitHub Copilot in a real-world scenario
100+
- Gain hands-on experience with **GitHub Copilot** in a real-world scenario
99101
- Learn strategies for effective AI-assisted development
100102
- Learn how to effectively prompt GitHub Copilot to get accurate responses from GitHub Copilot
101103
- Understand how to leverage Copilot across different languages and frameworks

docs/7_Troubleshooting/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Troubleshooting guide and FAQ
2+
3+
## Troubleshooting guide
4+
5+
To add
6+
7+
## FAQs
8+
9+
To add
10+
11+

0 commit comments

Comments
 (0)