Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions GettingStarted.md
Original file line number Diff line number Diff line change
@@ -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
```
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down