Fakultas Ilmu Komputer UI

README.md 4.44 KB
Newer Older
1
2
## Dietela Mobile Application

3
4
5
[![pipeline status](https://gitlab.cs.ui.ac.id/ppl-fasilkom-ui/2021/DD/pt-gizi-sehat-dietela/dietela-mobile/badges/staging/pipeline.svg)](https://gitlab.cs.ui.ac.id/ppl-fasilkom-ui/2021/DD/pt-gizi-sehat-dietela/dietela-mobile/-/commits/staging)
[![coverage report](https://gitlab.cs.ui.ac.id/ppl-fasilkom-ui/2021/DD/pt-gizi-sehat-dietela/dietela-mobile/badges/staging/coverage.svg)](https://gitlab.cs.ui.ac.id/ppl-fasilkom-ui/2021/DD/pt-gizi-sehat-dietela/dietela-mobile/-/commits/staging)

6
7
8
## About Dietela

Dietela is an Android-based application that provides personalised diet and online nutritionist consultation services.
Wulan Mantiri's avatar
Wulan Mantiri committed
9
Check out Dietela app by downloading the APK file [here](https://drive.google.com/drive/folders/1Irc2aiSuvhysRSDDd6pwAAfbgUkkobmk?usp=sharing)!
10

11
12
13
14
15
16
17
18
## Table of Contents

- [Getting Started](#getting-started)
- [Environment Configuration](#environment-configuration)
- [Current Features (PBIs)](#current-features-pbis)
- [Developers](#developers)

## Getting Started
19
20
21
22
23
24
25

* Install npm (version 6 or later).
* Install yarn by `npm install --global yarn`.
* Setup android development environment by following `React Native CLI Quickstart` guideline [here](https://reactnative.dev/docs/environment-setup).
* Clone the repository.
* Enter the project directory with `cd dietela-mobile`.
* Build the dependencies with `yarn install`.
26
* Create `.env` file by following the [environment configuration](#environment-configuration) instructions.
Wulan Mantiri's avatar
Wulan Mantiri committed
27
28
* Run and build the app in development node by running `yarn android`.
* View it in your Android emulator or physical device.
29

30
## Environment Configuration
Wulan Mantiri's avatar
Wulan Mantiri committed
31

32
We have three different environment settings:
Wulan Mantiri's avatar
Wulan Mantiri committed
33

34
35
36
37
38
| Environment   | Branch     | Example file             | Which env should I use?                                               |
| ------------- | ---------- | ------------------------ | --------------------------------------------------------------------- |
| Localhost     | -          | `.env.local.example`     | You are a backend developer wanting to test your code changes locally |
| Staging       | staging    | `.env.staging.example`   | You are a mobile developer wanting to update the app codebase         |
| Production    | master     | -                        | NOT for development purposes                                          |
Wulan Mantiri's avatar
Wulan Mantiri committed
39

40
For more granular configurations, use `.env.example` to get all needed environment variables and insert the missing values.
Wulan Mantiri's avatar
Wulan Mantiri committed
41

42
## Current Features (PBIs)
Wulan Mantiri's avatar
Wulan Mantiri committed
43

44
45
46
47
48
49
50
51
1. Dietela Quiz & Profile Dietku (Client) - Clients are required to fill out a quiz related to the design needs of the diet program that will be made by Dietela team.
2. Dietela Quiz & Profile Dietku (Dietela team) -  Dietela team can provide results containing diet assessment and program recommendations based on the clients' quiz answers.
3. Choose Plan - Clients can choose recommended diet program and nutritionist suitable for their needs.
4. Registration - Clients can create an account to access Dietela's premium features.
5. Login - Clients can sign in with a registered account or via Google authentication to access Dietela's premium features.
6. Logout - Clients can sign out from the Dietela app.
7. Checkout - Clients can view their chosen diet program and nutritionist and proceed to pay.
8. Payment Integration - Clients can perform payment using a third-party payment gateway (Midtrans).    
52
53
54
55
56
57
58
9. Diet Questionnaire - Clients can access the questionnaire feature to process further diet personalization.
10. Profile Dietku Nutritionist - Nutritionist can process questionnaire data and send it to the client.
11. Profile Dietku Client - Client can receive diet information from nutritionist in diet profile.
12. Profile Dietku Tim Dietela / Admin - Admin can recap clients' questionnaire answers and export them to a CSV file.
13. Progress Diet Client - Client can see questions about the diet personalization and answer them for diet report purposes.
14. Progress Diet Nutritionist - Nutritionist can receive information about their clients' diet reports and process them to give feedbacks.
15. Progress Diet Both Pages - Client can see the Nutritionist's feedbacks and the Nutritionist can edit the feedbacks.
Wulan Mantiri's avatar
Wulan Mantiri committed
59

60
61
62
63
64
65
66
67
68
69
70
71
## Developers

Team **we fall in love with PPL we cant have**

- Doan Andreas Nathanael - 1806205123
- Glenda Emanuella Sutanto - 1806133774
- Kefas Satrio Bangkit Solideantyo - 1806204972
- Muzaki Azami Khairevy - 1806205470
- Wulan Mantiri - 1806205666

## Acknowledgements
* CS UI - Software Engineering Project 2021