An open API service indexing awesome lists of open source software.

https://github.com/unlockway/unlockwayui

This repository keeps the source code of the user interface built with Flutter Framework.
https://github.com/unlockway/unlockwayui

codebase dart desktop flutter-app mobile-development ui unlockway

Last synced: about 1 month ago
JSON representation

This repository keeps the source code of the user interface built with Flutter Framework.

Awesome Lists containing this project

README

        

# 🥘 Healthy Meal Manager Mobile App (TCC Project)

![Unlockway Logo](./.github/assets/unlockway_logo.png)

![Flutter](https://img.shields.io/badge/Flutter-02569B?style=flat&logo=flutter&logoColor=white) ![Dart](https://img.shields.io/badge/Dart-0175C2?style=flat&logo=dart&logoColor=white) ![Android](https://img.shields.io/badge/Android-3DDC84?style=for-the-badge&logo=Android&logoColor=white)

> Acess the [PT-BR](./README-PTBR.md) Version

This project was developed during college as part of an interdisciplinary integration project (TCC). The Healthy Meal Manager Mobile App is a user-friendly Flutter application designed to help users manage their healthy meal routines and receive timely notifications. The app connects to a robust backend API built with Spring Boot, which handles meal planning, user data, and notifications.

The mobile app is built using Flutter and Dart, ensuring a smooth and responsive cross-platform experience for both Android and iOS users. It follows modern development practices and integrates seamlessly with the backend API for data management. The app features an intuitive user interface, designed with usability in mind, and leverages Flutter's rich widget library to deliver a polished experience.

For development, the app is tested on both physical devices and Android Studio emulators. It uses JWT-based authentication to securely communicate with the backend, ensuring user data is protected. The app is designed to be scalable and maintainable, making it easy to add new features or improvements in the future.

> Access the Layout prototype built on Figma clicking [here](https://www.figma.com/design/eVCIm7PVUYjDSV6PrifbAG/Fatec---Projeto-Integrador%3A-Unlockway?node-id=0-1&t=JH2hcRXH9DhEu4BF-1)

## Prerequisites

Before you begin, ensure you have the following installed:

- **Flutter SDK**: Install Flutter

- **Android Studio**: Download Android Studio

- **Java Development Kit (JDK)**: Install JDK

- **Git**: Install Git

## Setup Instructions

1. **Clone the Repositories**
First, clone the Unlockway UI repository:

```sh
git clone https://github.com/unlockway/unlockway_api_v2.git
cd unlockway_api_v2
# Follow the API's README for further setup
```

Next, clone the Unlockway API repository and follow its README for setup instructions:

```sh
git clone https://github.com/unlockway/unlockwayui
cd unlockwayui
```

2. **Set Up Your Device**
You can either use a physical device or create a virtual device using Android Studio:

- **Physical Device**: Enable Developer Mode and USB debugging on your Android device.

- **Virtual Device**: Follow the ![Android Studio AVD documentation](https://developer.android.com/studio/run/managing-avds) to create and configure an emulator.

## Running the Application

1. **Start the API Server**
Navigate to the API repository and start the server:

```sh
cd unlockway_api_v2
# Follow the API's README to start the server
```

2. **Run the Flutter App**
Navigate back to the Unlockway UI repository and run the app:

```sh
cd ../unlockwayui
flutter pub get
flutter run
```

## How to Contribute

1. **Fork the repository**

2. **Create a new branch:**

```sh
git checkout -b feature/your-feature-name
```

3. **Make your changes and commit them:**

```sh
git commit -m "Add your message here"
```

4. **Push to the branch:**

```sh
git push origin feature/your-feature-name
```

5. **Create a Pull Request**

### Contributors

| ![Victor H. Silva](https://github.com/vickttor.png) | ![Bruno Pequeno](https://github.com/bruno-pequeno.png) | ![Daniel Vieira](https://github.com/DanielVieira2828.png) | ![Felipe Thaylan](https://github.com/ThaylanFe.png) | ![João Zavisas](https://github.com/Zavisas.png) |
| :-------------------------------------------------: | :----------------------------------------------------: | :-------------------------------------------------------: | :-------------------------------------------------: | :---------------------------------------------: |
| [Victor H. Silva](https://github.com/vickttor) | [Bruno Pequeno](https://github.com/bruno-pequenor) | [Daniel Vieira](https://github.com/DanielVieira2828) | [Felipe Thaylan](https://github.com/ThaylanFe) | [João Zavisas](https://github.com/Zavisas) |