0% found this document useful (0 votes)
4 views5 pages

Project Submission Guidelines

The document outlines the project submission guidelines, including deliverables such as a one-page report, project source code on GitHub, data analytics implementation, hosting on online platforms, and a project video. It specifies the use of AI tools for boilerplate code while emphasizing the importance of understanding the code. The project must be completed by the end of Week 13, with a total timeline of three weeks for implementation and submission.

Uploaded by

東方曜
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
4 views5 pages

Project Submission Guidelines

The document outlines the project submission guidelines, including deliverables such as a one-page report, project source code on GitHub, data analytics implementation, hosting on online platforms, and a project video. It specifies the use of AI tools for boilerplate code while emphasizing the importance of understanding the code. The project must be completed by the end of Week 13, with a total timeline of three weeks for implementation and submission.

Uploaded by

東方曜
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 5

Project Submission Guidelines

Following are the project deliverables

1. One Page Report (Word/ PDF)

2. Project Source Code via GitHub

3. Data Analytics Implementation

4. Hosting via Online Platforms (e.g., Google Firebase, Vercel)

5. 3 to 5 Minute Project Video

Project submission deadline: End of Week 13

Use of AI: GenAI is a valuable tool that can aid in advancing software development. However,
excessive reliance on AI tools may hinder the learning experience. Students are permitted to
use AI for boilerplate code generation, such as templates, basic functionality, or overall
structure. However, they must ensure they fully understand the code and be able to explain
its purpose and implementation.

Project Timeline: The project implementation (coding part) is achievable within 8 to 12 days.
The remaining components, including the report and video, should be completed within 5 to
7 days. In total, the project would take no more than 3 weeks. If the project takes longer, it
may indicate that some aspects need to be reassessed. However, if any group feels they are
struggling to meet the deadline, they can reach out to me and discuss an adjusted timeline.

Analytics Integration: Apart from the project functionality, each project must integrate
analytics to collect and analyze user data. Details are given in this document.

Frameworks and technologies: Technologies mentioned in each project are a minimum


requirement of the use of technologies. If students desire, they can use advanced
frameworks and technologies like React, Vue, Next.js etc. There is no restriction on the use
of any technology as far as it reaches the minimum requirements mentioned in each
project.
Below is a detailed breakdown of each component and the instructions to follow for
submission.

1. Single Page Report

The one-page report should be concise, like a project poster. It should describe your
project, its features, and the analytics integration. The report must include the following
sections:

a. Project Overview:

• Title of the Project

• Description: Briefly describe your web application (e.g., what problem it solves, its
functionality, etc.)

• Technologies Used: List all the technologies you used for the front-end, back-end,
and data analytics. If any specific technology stack is utilized, also mention it in this
part.

b. Key Features:

• Describe the Key Features: Highlight the most important features of your web app.

c. Data Analytics Implementation:

• Analytics Tools Used: State which analytics tools you implemented (e.g., Google
Analytics, Vercel analytics, Mixpanel, Sentry etc.) and shortly describe their
purpose.

• Data Collection: Explain how data is being collected (e.g., user clicks, page views,
form submissions) and mention any custom events you have set up to track user
behavior.

• Outcome and Insights: Mention what insights you aim to collect and how this data
could improve the app (e.g., identifying drop-off points, tracking engagement, etc.).

d. Challenges Faced:

• Technical Challenges: Briefly describe any challenges you faced while developing
the app or integrating analytics.
• Solutions Implemented: Describe how you overcame those challenges.

e. Security (Optional):

• Security implementation: Describe how you implemented and utilized security


tools in your project.

2. Data Analytics Implementation (select any two features and show it in a dashboard
using tools like Grafana)

Ensure that your project has implemented analytics tools that track key metrics and
provide insights into user behavior. You can select online visualization tools or local
deployment using Docker. You need to demonstrate the following:

• Page Views & User Interactions: Track how users navigate through your app, which
pages they visit, and which actions they take (e.g., button clicks, form submissions).

• Custom Events: Implement and track custom events based on important user
interactions (e.g., successful form submissions, purchases, clicks on specific
features).

• Performance Metrics: Track the app’s performance, such as loading times and
response times using Google Analytics or other performance tools.

• Geographical metrics: How and where the app is being used.

• Analytics Dashboard: Create a simple report or dashboard (using tools like Google
Analytics, Grafana, or Mixpanel) that shows key data points (e.g., user retention,
traffic, top features).

You should include screenshots or a report of your analytics dashboard in your final
submission.

3. Project Source Code via GitHub

• Create a GitHub Repository: Your entire source code should be hosted in a public
GitHub repository. The repository must contain:

o All Source Code: All front-end and back-end code files (HTML, CSS,
JavaScript, server-side code, etc.).

o Basic README File: The repository should include a basic README file that
explains how to set up, run, and test your project. It should include:
• GitHub Link: Provide the link to your GitHub repository in the report and project
submission. Make sure it is accessible and not a private repository

4. Hosting via Online Platforms

Your project must be hosted on a public platform, ensuring that it is accessible to anyone
with a link. Choose one of the following platforms:

• Google Firebase:

o Firebase Hosting is a great option for web apps and is free for most use
cases.

o Follow the Firebase Hosting setup guide to deploy your app.

• Vercel:

o Vercel allows easy deployment of web apps and is ideal for static sites or
serverless functions.

o Follow the Vercel deployment guide to deploy your app.

• Netlify:

o Netlify is another great option for hosting static websites and supports
features like continuous deployment.

o Follow the Netlify deployment guide to deploy your project.

• GitHub Pages:

o If your project is a static web app, you can also host it directly on GitHub
Pages.

o Follow the GitHub Pages setup guide for deployment.

Once your web app is hosted, provide the URL of your deployed application in the report.

5. 3 to 5 Minute Project Video

Create a 3 to 5 minute video that explains your project, its features, and how data
analytics has been integrated. Follow these instructions to create a high-quality project
video:
a. Video Content:

• Introduction: Briefly introduce yourself and your project (1 minute).

• Features Demonstration: Walk through the features of your web app (2-3 minutes).

• Data Analytics Explanation: (About a minute)

• Conclusion: (30 seconds to 1 minute)

o Share what you’ve learned.

o Mention any challenges and how you overcome them.

b. Submit the Video:

• Upload your video to a platform like YouTube (set it to Unlisted if you don’t want it to
be public), Vimeo, or Google Drive.

• Provide the video link in your 1-page report and include it with your final submission.

Final Submission Checklist

1. Single-Page Report

2. Data Analytics

3. GitHub Repository

4. Project Hosting

5. Project Video

You might also like