Skip to content

Commit

Permalink
Merge pull request #12 from githubuniverseworkshops/update-grammar-an…
Browse files Browse the repository at this point in the history
…d-content

Update grammar and content
  • Loading branch information
bryantson authored Oct 25, 2024
2 parents 0faf55a + f2c9512 commit d45ed04
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 25 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,36 @@

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

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

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.
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.

> :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:
[**gh.io/octofit-tutorial**](https://gh.io/octofit-tutorial)

## Objectives and key takeaways

### Objectives

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

### Key takeaways

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

Without further ado, let's get started.

## Table of Contents

1. [The OctoFit Tracker app story](docs/1_Story/README.md)
2. [Prerequisites and asetup of the development environment](docs/2_Prerequisites/README.md)
2. [Prerequisites and a setup of the development environment](docs/2_Prerequisites/README.md)
3. [Getting started - app frontend and backend creation](docs/3_GettingStarted/README.md)
4. [The OctoFit Tracker database and app backend creation](docs/4_BackendSettings/README.md)
5. [Populate the database with sample data](docs/5_PopulateDBwData/README.md)
6. [Using the Codespace endpoint to access the Django REST Framework](docs/6_CodespaceDjangoRESTFramework/README.md)
7. [:fire: REFERENCE - Troubleshooting guide and FAQs](docs/7_Troubleshooting/README.md)
32 changes: 17 additions & 15 deletions docs/1_Story/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,27 @@

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

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.
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.

### Workshop Overview

In this workshop, you'll:

1. Set up a development environment using GitHub Codespaces
2. Use GitHub Copilot to accelerate development across multiple technologies
3. Build key components of the OctoFit Tracker app
4. Learn best practices and prompting techniques for working with GitHub Copilot
1. Set up a development environment using **GitHub Codespaces**
2. Use **GitHub Copilot** to accelerate development across multiple technologies
3. Build key components of the **OctoFit Tracker** app
4. Learn best practices and prompting techniques for working with **GitHub Copilot**

> :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.
### Application Features

OctoFit Tracker will include:
**OctoFit Tracker** will include:

- User authentication and profiles
- Activity logging and tracking
- Team creation and management
- Competitive leader boards
- Competitive leaderboards
- Personalized workout suggestions

### GitHub Copilot and Copilot Chat
Expand All @@ -40,7 +42,7 @@ OpenAI gpt-4o: *"Our high-intelligence flagship model for complex, multi-step ta
- [How to use GitHub Copilot: Prompts, tips, and use cases](https://github.blog/2023-06-20-how-to-write-better-prompts-for-github-copilot/)
- [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/)
- [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)
- [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/()
- [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/)

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"*

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

1. **Setup of Prerequisites**
2. **Setup of Prerequisites**
- Setting up GitHub Codespaces
- Ensure GitHub Copilot and Copilot Chat extensions are up to date

1. **Rapid Prototyping with GitHub Copilot**
3. **Rapid Prototyping with GitHub Copilot**
- Creating project structure
- Generating boilerplate code
- Implementing basic models, serializers, urls, and views

1. **Building Core Features**
4. **Building Core Features**
- User authentication
- Activity logging API
- Team management
- Leader board functionality

1. **Frontend Development**
5. **Frontend Development**
- Setting up React components
- Implementing responsive UI
- Connecting to backend APIs

1. **Advanced Features and Optimization**
6. **Advanced Features and Optimization**
- Adding personalized workout suggestions
- Implementing caching with Redis
- Optimizing database queries

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

By the end of this workshop, attendees will:

- Gain hands-on experience with GitHub Copilot in a real-world scenario
- Gain hands-on experience with **GitHub Copilot** in a real-world scenario
- Learn strategies for effective AI-assisted development
- Learn how to effectively prompt GitHub Copilot to get accurate responses from GitHub Copilot
- Understand how to leverage Copilot across different languages and frameworks
Expand Down
11 changes: 11 additions & 0 deletions docs/7_Troubleshooting/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Troubleshooting guide and FAQ

## Troubleshooting guide

To add

## FAQs

To add


0 comments on commit d45ed04

Please sign in to comment.