/MealsToGo

search for restaurants in any location to order food

Primary LanguageTypeScriptMIT LicenseMIT

Logo

Meals To Go

Search for Restaurants in any Location
Logo
Explore the docs »

Try it out · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started Development
  3. Getting Started Production

About The Project

This Project will be something between epal.gg or battlebuddy.gg

Built With

Getting Started Development

This is an example of setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites Development

This project requires NodeJS (version 16 or later), Expo Cli, Yarn, Firebase Cli, Stripe, Android Studio and Google Cloud.

  • Android Studio emulator configuration

  • Stripe create Account and copy live and test keys

  • Google Cloud Account - Enable: Places API, Geocoding API, Maps SDK for Android

  • node

    node -v
    v16.5.0
  • important to install this packages globaly

    npm i yarn expo-cli firebase-tools -g
  • login into your expo account

    expo signin
  • login into your firebase account and create a web project to get the API keys and enable functions

    firebase login:ci

Installation Development

  • Clone the repo

    git clone https://github.com/0-don/MealsToGo/ && cd MealsToGo && yarn && cd functions && yarn && cd..

App Development

  1. create .env environment file

    - Be sure too create `.env` file as explained in the `.env.example`

Firebase Functions Development

  1. create ./functions/.runtimeconfig.json environment file like in the example

    cd functions
    firebase functions:config:set stripe.test="sk_test_yourStripePrivateTestKey"
    firebase functions:config:set stripe.live="sk_live_yourStripePrivateLiveKey"
    firebase functions:config:set google.key="your google cloud key"
    firebase functions:config:get > .runtimeconfig.json
    cd ..
  2. start android emulator

    yarn android
  3. start firebase functions in new terminal

    cd functions
    yarn serve

Getting Started Production

This is an example of setting up your project on the web. To get the local copy up and running on the web follow these simple example steps.

  1. select you firebase project

    firebase use --add
  2. deploy functions

    cd functions
    yarn deploy
  3. package android apk

    cd ..
    expo build:android

Usage

Download the app register & login and test out the app

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Email - don.cryptus@gmail.com

Project Link: https://github.com/0-don/MealsToGo/