project virtual pet

Copain d'étude

Instructions

• Veuillez accéder à notre application en cliquant sur ce lien. (Remarque: la propagation DNS prend beaucoup de temps avec l'Université Temple, donc le lien vers le site ne fonctionnera pas lorsque vous utilisez le Wi-Fi de l'école - Tusecurewireless. Veuillez vous connecter à partir d'un autre réseau). Une fois sur place, vous pouvez créer un compte, sélectionner un animal de compagnie et explorer le site.
• Study Buddy est une application Web progressive (PWA). Cela signifie qu'il s'agit d'un site Web que vous pouvez utiliser dans votre navigateur, ou il peut être téléchargé sur votre appareil et utilisé comme une application.
  • Sur iOS: ouvrez safari et accédez au site. Appuyez sur le bouton "Partager" et sélectionnez "Ajouter à l'écran d'accueil" dans la fenêtre contextuelle. Enfin, appuyez sur "Ajouter" dans le coin supérieur droit pour terminer l'installation de la PWA. Il sera désormais sur votre écran d'accueil.
  • Sur Android: ouvrez Chrome et accédez au site. Appuyez sur l'icône "trois points" en haut à droite pour ouvrir le menu. Sélectionnez "Ajouter à l'écran d'accueil". Appuyez sur le bouton "Ajouter" dans la fenêtre contextuelle. La PWA est désormais installée et disponible sur votre écran d'accueil.
• Si vous rencontrez des bogues ou des problèmes, veuillez visiter notre site de documentation et cliquez sur le bouton "Rapport Bug" situé sur le côté droit de la page. Cela vous amènera à un formulaire de rétroaction où vous pouvez fournir des détails sur le problème que vous avez rencontré.

Mots clés

Section 704, application Web, Javascript, HTML, CSS, Python, Django, éducation, apprentissage, études, objectifs, rappels, animal de compagnie virtuel

Résumé du projet

Ce document propose une application Web progressive qui combine les avantages de la gamification et du développement personnel pour améliorer l'expérience de l'étude. L'application permet aux utilisateurs de s'occuper d'un animal de compagnie virtuel, qui sert de compagnon d'étude et de motivation. Les utilisateurs peuvent définir des objectifs quotidiens ou hebdomadaires, définir des rappels, suivre leurs progrès et se connecter avec leurs comptes de toile pour suivre les affectations. Les progrès de ces objectifs influenceront directement l'apparence et l'humeur de l'animal virtuel, des sentiments inspirants de motivation, de compagnie, de responsabilité et de solidarité de l'utilisateur. En utilisant cette application, les utilisateurs auront un moyen engageant et efficace d'améliorer leurs performances scolaires.

Exigence de haut niveau

L'application nécessite une connexion Internet pour fonctionner et peut être accessible sur n'importe quel appareil avec un navigateur Web moderne. Les utilisateurs peuvent définir des objectifs d'étude, suivre leurs progrès et se connecter avec leur compte Canvas. L'utilisateur sera récompensé pour avoir atteint ses objectifs d'étude via un système ponctuel, où le nombre de points donnés dépendra de la taille de la tâche terminée. Après avoir atteint un certain nombre de points, l'animal de compagnie de l'utilisateur se terminera. L'application s'intègre également à Canvas, permettant à l'utilisateur d'accéder et de suivre ses affectations. Les utilisateurs peuvent nommer leur animal de compagnie et interagir avec lui, et effectuer des tâches sur leur horaire qui affectent directement l'état et l'humeur de leur animal. L'humeur et l'apparence de l'animal seront influencées par la capacité de l'utilisateur à atteindre leurs objectifs.

Conception conceptuelle

Le frontend de l'application sera construit à l'aide de JavaScript, React, HTML et CSS. React sera utilisé pour créer des composants d'interface utilisateur et gérer l'état de l'application, et JavaScript, HTML et CSS seront utilisés pour créer l'interface utilisateur et gérer les interactions utilisateur. Le backend sera construit à l'aide de Python et Django pour gérer l'authentification et l'autorisation des utilisateurs, le stockage de données et les algorithmes qui déterminent comment l'apparence de l'animal virtuel change en fonction des habitudes d'étude de l'étudiant. SQLite sera utilisé pour stocker les données de l'utilisateur, telles que leurs objectifs d'étude, leurs progrès et leurs récompenses. L'application s'intègre également à la toile pour permettre aux étudiants de suivre leurs affectations et de classes et les inclura en tant qu'objectifs d'étude personnelle.

Arrière-plan

Des produits similaires incluent ma vie d'étude et mon quizlet. Ce sont tous deux des produits de source fermée qui visent à aider les étudiants à améliorer leurs résultats scolaires. Ma vie d'étude est un planificateur étudiant en ligne qui permet aux étudiants de suivre leurs délais et leurs cours. Quizlet permet aux étudiants de créer des flashcards et des quiz pour étudier pour leurs cours. L'application Buddy Study est similaire à ces produits dans la mesure où l'objectif est de fournir des ressources pour aider les étudiants à réussir sur le plan scolaire et à rester au courant de leurs cours. Cependant, cette application intègre également l'aspect unique d'un compagnon de compagnie virtuel pour les aider à rester motivés à étudier. L'application Buddy Study comprendra certaines des mêmes caractéristiques que Quizlet et ma vie d'étude, comme définir des rappels ou créer et lier à des matériaux d'étude.

Une autre application mobile à source fermée, intitulée Finch, consiste à prendre soin d'un animal de compagnie virtuel pour atteindre des objectifs d'autosoins. Habitica est une application Web open source qui aide les utilisateurs à gamifier leur vie en leur permettant de fixer des objectifs pour suivre les habitudes personnelles. L'intégration du concept de prendre soin d'un animal de compagnie et de tâches personnelles et académiques gamifiant, car dans cette application, avec les fonctionnalités d'une application d'étude, permettra aux utilisateurs une expérience plus personnalisée et amusante de réussir dans leurs activités académiques.

Ressources requises

La recherche devra être menée sur les différentes ressources logicielles nécessaires pour terminer ce projet, notamment JavaScript, React, HTML / CSS, Django, Sqlite et Canvas API. React sera utilisé pour le frontal, Django pour le back-end, et une combinaison d'une base de données SQLite avec un schéma défini et géré par Django et un magasin de fichiers statique. Une ressource requise est un serveur Ubuntu qui sera exécuté sur un ancien ordinateur portable ou un service d'hébergement sera utilisé. Aucune autre ressource matérielle n'est requise.

Instructions de construction locales

Condition préalable

• Python 3,8 ou plus

• pip3 22 ou plus

• NPM 8 ou plus

Une clé secrète et un mot de passe Gmail seront requis dans le fichier .env backend pour que le projet s'exécute correctement. Si vous êtes un développeur approuvé sur ce projet, contactez votre équipe pour recevoir les informations d'identification requises. La modification du code source du code backend sera requise afin d'envoyer des vérifications par e-mail sur l'enregistrement des utilisateurs. Notre équipe est heureuse de vous aider à vous guider tout au long de ce processus.

Installation

1. Téléchargez le fichier zip dans la version et ouvrez. Ouvrez un terminal, puis accédez au répertoire du projet.

2. Insérez vos clés de développement à ~/sb/backend/.env

 SECRET_KEY=<YOUR-KEY>
GMAIL_PASSWORD=<YOUR-PASSWORD>

3. Accédez au backend:

 cd < your-path > /sb/backend 

4. Activez un environnement virtuel Python et installez les dépendances:

(MacOS / Unix)

 source tutorial-env/bin/activate
pip3 install -r requirements.txt

Fenêtre

tutorial-env S cripts a ctivate.bat
pip3 install -r requirements.txt

5. Activez le backend avec les instructions suivantes:

python3 manage.py makemigrations
python3 manage.py migrate
python3 manage.py runserver

6. Maintenant, ouvrez un nouveau terminal et dans le répertoire du projet, accédez au frontend:

 cd < your-path > /sb/frontend

7. Construisez le frontend comme suit. Les dépendances seront téléchargées et compilées pour vous:

npm install 
npm run build 
nmp start

8. Dans votre navigateur, naviguez dans la barre de recherche vers http: // localhost: 3000.

Collaborateurs

Mary Clay

Christine Cho

Alexander Russakoff

Katrina Janeczko

Harrison Fedor

Jay Newman

Ian Tyler Applebaum