Greeny

Aplicació de mobilitat sostenible

Table of Contents

• Greeny
  • Table of Contents
  • CI/CD Status
    • main branch status
    • development branch status
  • Integrants
  • Conception of the project
  • Vídeo Demo de Greeny
  • Com es calculen els teus punts?
  • Instal·lar release APK a dispositius ANDROID
  • Instruccions per executar el projecte
    • Backend
      • Posar en marxa:
      • Run dels dockers corresponents
      • Per fer migracions
      • Per crear migracions
    • Frontend
      • Preparació
      • Run app
      • Instal·lar la app
  • Folder Sctructure

CI/CD Status

main branch status

development branch status

Integrants

• Amorín Díaz, Miquel
• Costabella Moreno, Agustí
• López Buira, Iván
• López Ruiz, Alba
• Mostazo Gonzalez, Marc
• Tajahuerce Brulles, Arnau
• Vega Centeno, Javier

Conception of the project

El nostre projecte consisteix en una aplicació mòbil que té com a idea principal un concepte innovador: un joc interactiu orientat en la sostenibilitat urbana, centrat en l'objectiu de descontaminar una ciutat. Mitjançant una aplicació mòbil, els usuaris tindran l'oportunitat de participar activament en aquest desafiament ambiental. A través de mecàniques de joc inspiradores i educatives, els jugadors seran responsables de prendre decisions sobre els seus desplaçaments diaris i, al mateix temps, contribuir a la reducció de la contaminació i al creixement de la sostenibilitat urbana.

La proposta del nostre projecte ofereix una experiència lúdica única, on els usuaris no només reben informació sobre punts de recàrrega elèctrica, estacions de Bicing i parades de transport públic, sinó que també es converteixen en protagonistes de la transformació d'una ciutat contaminada en un entorn més saludable i sostenible. Amb una combinació de gamificació, geolocalització i interacció social, aspirem a crear una plataforma que no només entretingui, sinó que també eduqui i motivi els usuaris a adoptar hàbits de vida més respectuosos amb el medi ambient. Així, el nostre projecte no només és una aplicació mòbil, sinó una iniciativa per a la conscienciació i la millora de la sostenibilitat urbana.

Vídeo Demo de Greeny

El següent vídeo conté una demostració de totes les funcionalitats de l'aplicació Greeny:

Greeny.demo.Video.mp4

Com es calculen els teus punts?

Utilitzant aquesta fórmula:

def calculate_points(co2_consumed, car_co2_consumed):
    # Calculate the points earned by the user
    alpha = 1 if co2_consumed == 0 else car_co2_consumed / co2_consumed
    co2_saved = max(0, car_co2_consumed - co2_consumed)
    total_points = co2_saved * alpha

    multiplier = 20

    return int(round(total_points * multiplier))

La fórmula calcula la diferència entre el CO2 consumit i el CO2 que hauries consumit fent la ruta en un cotxe de combustió.

En conseqüència en fer una ruta en cotxe de combustió no es guanyaran punts, ja que no s'ha estalviat CO2.

Instal·lar release APK a dispositius ANDROID

Instalar l'aplicació Greeny.apk de la Última Release al teu dispositiu.

Instruccions per executar el projecte

Backend

Posar en marxa:

1. Baixarse el repo

2. Instal·lar-se docker

3. Situarse a la carpeta backend

Run dels dockers corresponents

docker-compose build
docker compose up

Per fer migracions

docker compose run backend python manage.py migrate

Per crear migracions

docker compose run backend python manage.py makemigrations

Note: Assegurat de posar al ./Backend/.env les variables d'entorn necessaries:

POSTGRES_NAME=
POSTGRES_USER=
POSTGRES_PASSWORD=
POSTGRES_DB=
DB_HOST=
API_KEY=
API_KEY_ID=
APP_TOKEN=
APP_ID=
API_TOKEN_AJT=

Frontend

Macos: Descarregar cocoapod

Preparació

1. Instal·lar extensió flutter a vscode (potser també instalar flutter)
2. Instal·lar emulador mobil (Xcode/Android Studio)

Run app

1. A baix a la dreta de vscode seleccionar un dispositiu per executar el front end
2. Seleccionar l'arxiu ./App/greeny/lib/main.dart
3. Donar-li a Start debugging.

Instal·lar la app

flutter run --release

Note: Assegurat de posar al ./App/greeny/.env el BACKEND_URL= necessari:

BACKEND_URL = 'url o IP del backend'

Per defecte: BACKEND_URL = 'nattech.fib.upc.edu:40351'

Folder Sctructure

.
├── App
│   └── greeny
│       ├── analysis_options.yaml
│       ├── android
│       ├── assets          #Directori d'assets de l'aplicació
│       ├── build
│       ├── greeny.iml
│       ├── ios
│       ├── lib             #Directori que conté el codi principal de l'aplicació
│       ├── linux
│       ├── macos
│       ├── pubspec.lock
│       ├── pubspec.yaml    #Arxiu que conte la llista de dependencies i altra informació 
│       │                   rellevant per el gestor de paquets Dart (pub)
│       ├── test            #Directori que conté els tests del Frontend
│       ├── web
│       └── windows
├── Backend
│   ├── Dockerfile          #Arxiu amb instruccions per construir la imatge del Backend
│   ├── api                 #Directori amb el codi de la API del Backend
│   ├── docker-compose.yml  #Arxiu amb la configuració dels contenidors
│   ├── greeny
│   ├── manage.py
│   ├── uploads/imatges     #Directori amb les fotos de perfil dels usuaris registrats
│   └── requirements.txt    #Dependencies del Backend
├── LICENSE.md              #Apache License del repositori
└── README.md               #README del repositori