Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed EyeSpy incorrect file in ExampleProject, updated example project to be more understandable #430

Merged
merged 1 commit into from
Jul 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions content/docs/2024/ExampleProject/week1.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,42 +8,42 @@ title: "Week #1"

### **Team Members**

| Team Member | Telegram ID | Email Address |
|--------------------------|---------------|-----------------|
| Team Member (Lead) 1 | [Telegram ID] | [Email address] |
| Team Member 2 | [Telegram ID] | [Email address] |
| Team Member 3 | [Telegram ID] | [Email address] |
| Team Member 4 | [Telegram ID] | [Email address] |
| Team Member 5 | [Telegram ID] | [Email address] |
| (Optional) Team Member 6 | [Telegram ID] | [Email address] |
| (Optional) Team Member 7 | [Telegram ID] | [Email address] |
| Team Member | Telegram ID | Email Address |
|-----------------------------------------|---------------|-----------------|
| [Team Member (Lead) Name Surname 1] | [Telegram ID] | [Email address] |
| [Team Member Name Surname 2] | [Telegram ID] | [Email address] |
| [Team Member Name Surname 3] | [Telegram ID] | [Email address] |
| [Team Member Name Surname 4] | [Telegram ID] | [Email address] |
| [Team Member Name Surname 5] | [Telegram ID] | [Email address] |
| [(Optional) Team Member Name Surname 6] | [Telegram ID] | [Email address] |
| [(Optional) Team Member Name Surname 7] | [Telegram ID] | [Email address] |

### **Value Proposition**

- Identify the Problem:
...
...

- Solution Description:
...
...

- Benefits to Users:
...
...

- Differentiation:
...
...

- User Impact:
...
...

- User Testimonials or Use Cases:
...
...

## **Lean Questionnaire**

Please answer the following questions related to the lean methodology:

1. What problem or need does your software project address?
1. What problem or need does your software project address?

...

2. Who are your target users or customers?
Expand Down
18 changes: 9 additions & 9 deletions content/docs/2024/ExampleProject/week2.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,15 +48,15 @@ title: "Week #2"

### **Tech Stack and Team Allocation**

| Team Member | Track | Responsibilities |
|--------------------------|---------------------------------------------|--------------------|
| Team Member (Lead) 1 | [Backend/Frontend/Fullstack/ML/Design/etc.] | [Responsibilities] |
| Team Member 2 | [Backend/Frontend/Fullstack/ML/Design/etc.] | [Responsibilities] |
| Team Member 3 | [Backend/Frontend/Fullstack/ML/Design/etc.] | [Responsibilities] |
| Team Member 4 | [Backend/Frontend/Fullstack/ML/Design/etc.] | [Responsibilities] |
| Team Member 5 | [Backend/Frontend/Fullstack/ML/Design/etc.] | [Responsibilities] |
| (Optional) Team Member 6 | [Backend/Frontend/Fullstack/ML/Design/etc.] | [Responsibilities] |
| (Optional) Team Member 7 | [Backend/Frontend/Fullstack/ML/Design/etc.] | [Responsibilities] |
| Team Member | Track | Responsibilities |
|-----------------------------------------|---------------------------------------------|--------------------|
| [Team Member (Lead) Name Surname 1] | [Backend/Frontend/Fullstack/ML/Design/etc.] | [Responsibilities] |
| [Team Member Name Surname 2] | [Backend/Frontend/Fullstack/ML/Design/etc.] | [Responsibilities] |
| [Team Member Name Surname 3] | [Backend/Frontend/Fullstack/ML/Design/etc.] | [Responsibilities] |
| [Team Member Name Surname 4] | [Backend/Frontend/Fullstack/ML/Design/etc.] | [Responsibilities] |
| [Team Member Name Surname 5] | [Backend/Frontend/Fullstack/ML/Design/etc.] | [Responsibilities] |
| [(Optional) Team Member Name Surname 6] | [Backend/Frontend/Fullstack/ML/Design/etc.] | [Responsibilities] |
| [(Optional) Team Member Name Surname 7] | [Backend/Frontend/Fullstack/ML/Design/etc.] | [Responsibilities] |

### **Weekly Progress Report**

Expand Down
4 changes: 4 additions & 0 deletions content/docs/2024/ExampleProject/week5.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ title: "Week #5"

# **Week #5**

## **MVP**

Links and description of MVP...

## **Feedbacks**

- **Feedback collection plan**
Expand Down
12 changes: 8 additions & 4 deletions content/docs/2024/ExampleProject/week6.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,20 @@ title: "Week #6"

## **Presentation**:

[Link](https://docs.google.com/presentation/d/1pzzyCCOy3LKhhZgtP4IPKX7lJaxyXHQu2IZAFEurTr4/edit?usp=sharing) to the presentation draft.
...

## **Link to the deployed project**:

...

## **Weekly Progress Report**:

Our team implemented the entire server-client communication system this week. We also completed the admin console, allowing administrators to create rooms and monitor participants in real-time. Additionally, we added UIs for joining rooms to the SwiftUI client.
Our team did...

### **Challenges & Solutions**

The main challenge was achieving real-time updates efficiently. We resolved this by implementing websocket communication, which offers a low-latency, performance-friendly solution for server-client interactions.
...

### **Conclusions & Next Steps**

We concluded that while our system is functional, there is room for improvement. We need to train our model further and incorporate advanced techniques such as detecting other humans in the frame, audio processing to ensure the user isn't speaking with anyone else, and gesture recognition. Additionally, we plan to enhance the UI. Although we followed SwiftUI guidelines and used common components, developing a design system and implementing it could significantly improve the overall look and feel of the app.
...
21 changes: 21 additions & 0 deletions content/docs/2024/EyeSpy/week6.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Week #6"
---

# **Week #6**

## **Presentation**:

[Link](https://docs.google.com/presentation/d/1pzzyCCOy3LKhhZgtP4IPKX7lJaxyXHQu2IZAFEurTr4/edit?usp=sharing) to the presentation draft.

## **Weekly Progress Report**:

Our team implemented the entire server-client communication system this week. We also completed the admin console, allowing administrators to create rooms and monitor participants in real-time. Additionally, we added UIs for joining rooms to the SwiftUI client.

### **Challenges & Solutions**

The main challenge was achieving real-time updates efficiently. We resolved this by implementing websocket communication, which offers a low-latency, performance-friendly solution for server-client interactions.

### **Conclusions & Next Steps**

We concluded that while our system is functional, there is room for improvement. We need to train our model further and incorporate advanced techniques such as detecting other humans in the frame, audio processing to ensure the user isn't speaking with anyone else, and gesture recognition. Additionally, we plan to enhance the UI. Although we followed SwiftUI guidelines and used common components, developing a design system and implementing it could significantly improve the overall look and feel of the app.
21 changes: 11 additions & 10 deletions content/docs/CourseDescription/WeeklyTasks/Week_1.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Please provide in your reporting markdown file the following information for you
### **Team Members**

Please list the names and contact details (Telegram and email) of your team members:

{{<details "Important Note" >}}

When building a team for a software project consisting of 5-7 people, it is crucial to pay attention to the following:
Expand All @@ -59,17 +60,17 @@ When building a team for a software project consisting of 5-7 people, it is cruc

Remember, building a successful software project goes beyond individual skills. It requires a combination of technical expertise, effective communication, collaboration, and a shared commitment to achieving project goals. By paying attention to these aspects, you can lay a strong foundation for your team's success.


{{</details>}}
| Team Member | Telegram ID | Email Address |
|--------------------------|---------------|-----------------|
| Team Member (Lead) 1 | [Telegram ID] | [Email address] |
| Team Member 2 | [Telegram ID] | [Email address] |
| Team Member 3 | [Telegram ID] | [Email address] |
| Team Member 4 | [Telegram ID] | [Email address] |
| Team Member 5 | [Telegram ID] | [Email address] |
| (Optional) Team Member 6 | [Telegram ID] | [Email address] |
| (Optional) Team Member 7 | [Telegram ID] | [Email address] |

| Team Member | Telegram ID | Email Address |
|-----------------------------------------|---------------|-----------------|
| [Team Member (Lead) Name Surname 1] | [Telegram ID] | [Email address] |
| [Team Member Name Surname 2] | [Telegram ID] | [Email address] |
| [Team Member Name Surname 3] | [Telegram ID] | [Email address] |
| [Team Member Name Surname 4] | [Telegram ID] | [Email address] |
| [Team Member Name Surname 5] | [Telegram ID] | [Email address] |
| [(Optional) Team Member Name Surname 6] | [Telegram ID] | [Email address] |
| [(Optional) Team Member Name Surname 7] | [Telegram ID] | [Email address] |


### **Value Proposition**
Expand Down
Loading