Data

Tools

Indexes

Applications

Experiments

Open Source Science

emotionapp

Emotion app is a web application that can record learners’ emotions in real time and allow researchers to customize questionnaires.

https://github.com/carrrmenleong/emotionapp

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.6%) to scientific vocabulary

Keywords

bootstrap5 flask jinja2-templates
Last synced: 6 months ago · JSON representation ·

Repository

Emotion app is a web application that can record learners’ emotions in real time and allow researchers to customize questionnaires.

Basic Info
  • Host: GitHub
  • Owner: carrrmenleong
  • License: cc0-1.0
  • Language: HTML
  • Default Branch: development
  • Homepage: https://emotionapp.fly.dev
  • Size: 501 KB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 1
  • Open Issues: 4
  • Releases: 1
Topics
bootstrap5 flask jinja2-templates
Created over 3 years ago · Last pushed almost 3 years ago
Metadata Files
Readme License Citation

README.md

EmotionApp

Emotion app is a web application that can record learners’ emotions in real time and allow researchers to customize questionnaires.

Getting Started for development

1. Clone the repository

$ git clone https://github.com/carrrmenleong/EmotionApp.git $ cd EmotionApp

2. Create and activate a virtual environment

Unix/Linux:

$ python -m venv venv $ source venv/bin/activate

Windows:

$ python -m venv venv $ venv\Scripts\activate

3. Install requirements

$ pip install -r requirements.txt

4. Setup database

$ flask db upgrade

5. Setup database for testing (optional)

Copy app.db file and rename the copied file to test.db which will be used during testing

6. Get and store .env file locally

Contact one of the contributors or the owner of this project for the .env file. Then, store the .env file locally in the root directory of your cloned project.

7. Run the application

$ flask run

Development Workflow

  1. Choose the issue you want to work on.
  2. Assign yourselves to the relevant issue on GitHub.
  3. Create a branch corresponding to the issue with the format i<issue_number>-<issue_name>.
  4. Checkout to the issue branch.
  5. Work on your changes.
  6. Make commits and push them to the issue branch.
  7. Open a pull request on GitHub.
  8. Get your peer to review your code and merge your change to main.
  9. Your feature is merged.
  10. Delete your local branch with git branch -d <branch_name>.

Development Practise

1. Update requirements.txt

After installing new pakage(s), run the following code in your virtual environment to update the requirements.txt file. $ pip freeze > requirements.txt To download the pakages listed in the requirements.txt file, run the following code in your virtual environment. $ pip install -r requirements.txt

Testing the application (backend)

1. Run the unit and funcional tests

$ python -m pytest -v --disable-warnings --cov=app --cov-report html

2. Read the test report

Open up htmlcov/index.html to read the test report

Owner

  • Name: Carmen
  • Login: carrrmenleong
  • Kind: user

🦭 Web dev is fun! 🦭

Citation (CITATION.cff) 

cff-version: 1.1.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Fraschini
    given-names: Nicola
    orcid: https://orcid.org/0000-0002-9353-6319
  - family-names: Sampson
    given-names: Richard J.
    orcid: https://orcid.org/0000-0002-9068-317X
  - family-names: Leong
    given-names: Carmen
  - family-names: Tan
    given-names: Mandeal
  - family-names: Goh
    given-names: Wai Yee
  - family-names: O'Connor
    given-names: Bryce
title: EmotionApp: First Release
version: v1.0.0
date-released: 2022-11-24

GitHub Events

Total
Last Year

Dependencies

requirements.txt pypi
  • Flask ==2.2.2
  • Flask-JSGlue ==0.3.1
  • Flask-Login ==0.6.2
  • Flask-Mail ==0.9.1
  • Flask-Migrate ==3.1.0
  • Flask-SQLAlchemy ==2.5.1
  • Flask-WTF ==1.0.1
  • Jinja2 ==3.1.2
  • Mako ==1.2.1
  • MarkupSafe ==2.1.1
  • PyJWT ==2.4.0
  • Pygments ==2.13.0
  • SQLAlchemy ==1.4.40
  • WTForms ==3.0.1
  • Werkzeug ==2.2.2
  • alembic ==1.8.1
  • asttokens ==2.0.8
  • backcall ==0.2.0
  • blinker ==1.5
  • click ==8.1.3
  • colorama ==0.4.5
  • debugpy ==1.6.3
  • decorator ==5.1.1
  • dnspython ==2.2.1
  • email-validator ==1.2.1
  • entrypoints ==0.4
  • executing ==0.10.0
  • greenlet ==1.1.2
  • idna ==3.3
  • importlib-metadata ==4.12.0
  • ipykernel ==6.15.1
  • ipython ==8.4.0
  • itsdangerous ==2.1.2
  • jedi ==0.18.1
  • jupyter-core ==4.11.1
  • jupyter_client ==7.3.5
  • matplotlib-inline ==0.1.6
  • nest-asyncio ==1.5.5
  • packaging ==21.3
  • parso ==0.8.3
  • pickleshare ==0.7.5
  • prompt-toolkit ==3.0.30
  • psutil ==5.9.1
  • pure-eval ==0.2.2
  • pyparsing ==3.0.9
  • python-dateutil ==2.8.2
  • python-dotenv ==0.20.0
  • pywin32 ==304
  • pyzmq ==23.2.1
  • six ==1.16.0
  • stack-data ==0.4.0
  • tornado ==6.2
  • traitlets ==5.3.0
  • wcwidth ==0.2.5
  • zipp ==3.8.1
.github/workflows/fly_deploy_dev.yml actions
  • actions/checkout v3 composite
  • superfly/flyctl-actions/setup-flyctl master composite
.github/workflows/python-app.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite