Skip to content

mikkegt/ownplate

 
 

Repository files navigation

OwnPlate-Logo

OwnPlate

This is an open source project for a take-out order service, which allows restaurants to create their own menu + order page. Unlike Caviar or UberEats (which charges 12% to 30% + credit card transaction fee), it costs only the credit card transaction fee (via Stripe, 2.9% + 30cents).

It is built with Firebase + Vue + Stripe, for productivity and scalability.

SPEC

Setup Firebase

  • Authentication
    • Enable email/password and phone authentication as Sign-in providers
    • Add your domain if you use custom domain.
  • Database
    • Create Firestore database
  • Hosting
    • Enable hosting
    • Add your domain if you use custom domain.
  • Storage
    • Enable Storage.
  • Functions
    • Enable functions.
  • AppCheck
    • Enable App Check

Setup Stripe

TBD.

Setup OwnPlate configuration

Environment variable

TBD.

src/config/project.js

TBD.

Deploy to firebase

see GitHub Actions setting.

.github/workflows/deploy.yml

Run the development server on localhost

# install dependencies
$ yarn install

# copy and edit project.ts file
$ cp src/config/default/ownplate-dev.ts src/config/project.ts

$ yarn start

Build Vue.js.

see GitHub Actions setting. This file

.github/workflows/deploy.yml

This file contains the latest and valid information for the build.

Build for production

$ yarn run build

Function

You need to deploy Function for develoment.

cd functions && yarn install
firebase deploy --only functions

Icon lists

https://materializecss.com/icons.html https://iconify.design/icon-sets/mdi/

https://fontawesome.com/icons?d=gallery https://materialdesignicons.com/cdn/2.0.46/

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Vue 62.4%
  • TypeScript 36.1%
  • JavaScript 1.3%
  • Other 0.2%