https://github.com/joshualim30/kitchin

https://github.com/joshualim30/kitchin

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/joshualim30/kitchin
• Owner: joshualim30
• Created: 2024-08-31T03:05:00.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-07T22:22:06.000Z (4 months ago)
• Last Synced: 2024-09-07T23:28:54.654Z (4 months ago)
• Language: Dart
• Size: 278 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# kitchin

## Your Kitchen. Your Way.

# Table of Contents

1. [Introduction](#introduction)

2. [Installation](#installation)

3. [Usage](#usage)

4. [Contributing](#contributing)

5. [License](#license)

## Introduction

Still under development...

## Installation

KitchIN is a mobile application that can be downloaded from the App Store or Google Play Store. To deploy the application locally, follow the instructions below:

1. Download the necessary files from the GitHub repository, located at [https://github.com/joshualim30/kitchin](https://github.com/joshualim30/kitchin).

2. Install a code editor, such as [Visual Studio Code](https://code.visualstudio.com/).

    2.1. Install Android Studio and the Android Emulator.

    2.2. (Optional, Mac only) Install Xcode and the iOS Simulator.

3. Install [Flutter](https://flutter.dev/) and [Dart](https://dart.dev/) on your local machine. More detailed instructions can be found in the [Flutter documentation](https://flutter.dev/docs/get-started/install).

4. Open the project in Visual Studio Code and run the following command in the terminal:

    ```

    flutter pub get

    ```

5. Download the [Firebase CLI](https://firebase.google.com/docs/cli) and set up a Firebase project (if you were not invited to the existing project).

6. Authenticate the Firebase CLI with your Google account by running the following command in the terminal:

    ```

    firebase login

    ```

    You will be prompted to sign in with your Google account. More detailed instructions can be found in the [Firebase documentation](https://firebase.google.com/docs/flutter/setup).

7. Create a .ENV file in the root directory of the project and add the following environment variables:

    `TODO: Add environment variables`

8. Run the following command in the terminal to deploy the application locally:

    ```

    flutter run

    ```

    Or to run a release build:

    ```

    flutter run --release

    ```