rendoir / feup-ldso

University of Porto's Cultural Agenda

Acontece na UPorto - Cultural Agenda of University of Porto

University of Porto's cultural agenda. It will contain all the events of all the faculties and cultural organizations related to UPorto, for ease of access to such information, as well as an event management for organizations

Getting Started

These instructions will show you how to install the project

Prerequisites

You will need:

• Docker - https://www.docker.com/get-started
• NodeJS and npm - https://nodejs.org/en/
• Expo - https://expo.io/learn
• Expo App on Android
• Android Studio Emulator - If you don't have an Android, you can use the AS emulator to test.
• A Google API Key - https://support.google.com/googleapi/answer/6158862?hl=en
• A SHA-1 Certificate Fingerprint - https://developers.google.com/android/guides/client-auth

1st time Configuration

• Replace apiKey and certificateHash in mobile/app.json with your Google API Key and SHA-1 Certificate Fingerprint
• Run docker-compose build in the root of the project, to setup the app and the web modules.
• Run npm install in the mobile folder.

Running for development

1. Run docker-compose up in the root of the project
2. In the file mobile/global.js, change the presented IP to your machine's wifi IP.
3. Run expo start. Inside the terminal, there should be a QRCode to be read via the Expo App. 3.1. You can also access more information in indicated localhost IP.

Running with an Android Emulator

If you're using an Android emulator, such as the NoxPlayer Emulator:

1. Connect the device with the adb connect command (for example, adb connect 127.0.0.1:62001) and run the emulator.
2. Run expo start and, in the indicated localhost IP, select Run on Android device/emulator.

Running the tests

To run the tests:

• Inside the api folder, run command npm test
• Inside the _web__folder, run command npm test
• Inside the _mobile_folder, run command npm test -- -u

Running Linter

To run lint, run command npm run lint.

Test Examples

• /GET List Events App - It tests the return of all events on the app, listing them by order of the attribute start_date
• /POST Add Event - It tests the addition of an event to the database

Built with

• React-Native - The Android Framework

Servers

• Staging:
  • Web - 188.166.95.23:3000
  • API - 188.166.95.23:3030
• Production:
  • Web - 188.166.41.239:3000
  • API - 188.166.41.239:3030

Mobile app APK

• You can download the APK to install the app here: APK

API Documentation

To access the documentation of the API:

• Staging:
  • 188.166.95.23:3030/docs
• Production:
  • 188.166.41.239:3030/docs

Authors

• Daniel Marques - Developer - rendoir
• Danny Soares - Developer - dannysoares
• Leonardo Teixeira - Developer - LeoTeixeira
• Margarida Silva - Scrum Master - BeeMargarida
• Ricardo Santos - Developer - rjsantos
• Tiago Carvalho - Developer - TiagoC97
• Vítor Magalhães - Surrogate Product Owner - LastLombax