From 2d89b356862be46033f294a1e0ef3ba2a3616afe Mon Sep 17 00:00:00 2001 From: isacostaf Date: Wed, 21 May 2025 10:01:54 -0300 Subject: [PATCH] Getting Started File --- GettingStarted.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ README.md | 4 ++++ 2 files changed, 50 insertions(+) create mode 100644 GettingStarted.md diff --git a/GettingStarted.md b/GettingStarted.md new file mode 100644 index 000000000..fe5dc2e4f --- /dev/null +++ b/GettingStarted.md @@ -0,0 +1,46 @@ +# Getting Started +For setup first you need the following things: +- Flutter Version 3.27.1 +- IDE like Android Studio or VS Code with Flutter Plugin installed. + +## Steps to run App +1.⁠ ⁠Clone the repository with Git + +```git clone https://github.com/simonoppowa/OpenNutriTracker.git``` + +2.⁠ ⁠Get Dependencies + +```flutter pub get``` + +3.⁠ ⁠Run Build Runner to generate Files + +```flutter pub run build_runner build``` + +4.⁠ ⁠Run App + +```flutter run lib/main.dart``` + +## Running the Application + +The application can be run on multiple platforms. Here are the commands for each: + +### Web (Chrome) +```bash +flutter run -d chrome +``` + +### iOS +```bash +open -a Simulator +flutter run +``` + +### macOS +```bash +flutter run -d macos +``` + +### Android +```bash +flutter run -d android +``` diff --git a/README.md b/README.md index dc6cdebcf..b1d31bdfa 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,10 @@ See [Data Protection](https://www.iubenda.com/privacy-policy/53501884) ## Contribution Contributions to OpenNutriTracker are welcome! If you find any issues or have suggestions for new features, please open an issue or submit a pull request. Make sure to follow the project's code style and guidelines. +## Getting Started +See the [Getting Started](GettingStarted.md) file for more information. + + ## Disclaimer OpenNutriTracker is not a medical application. All data provided is not validated and should be used with caution. Please maintain a healthy lifestyle and consult a professional if you have any problems. Use during illness, pregnancy or lactation is not recommended.