MCPcopy Index your code
hub / github.com/Nakajima-Foundation/ownplate

github.com/Nakajima-Foundation/ownplate @v4.0.1

Chat with this repo
repository ↗ · DeepWiki ↗ · release v4.0.1 ↗ · + Follow
544 symbols 1,340 edges 194 files 0 documented · 0%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

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/

Extension points exported contracts — how you extend this code

LineVerifyResponse (Interface)
(no doc)
functions/src/lib/types/line.ts
Window (Interface)
(no doc)
src/shims-tsx.d.ts
PostageInfo (Interface)
(no doc)
src/utils/commonUtils.ts
CustomRoute (Interface)
(no doc)
src/lib/router.ts
Claims (Interface)
(no doc)
src/store/user.ts
ShopOwnerData (Interface)
(no doc)
src/models/ShopOwner.ts
LineAccessTokenResponse (Interface)
(no doc)
functions/src/lib/types/line.ts
Element (Interface)
(no doc)
src/shims-tsx.d.ts

Core symbols most depended-on inside this repo

get
called by 121
functions/src/smaregi/smaregiapi.ts
exportIfNeeded
called by 30
functions/src/lib/exportifneeded.ts
update
called by 30
functions/src/smaregi/smaregiapi.ts
escapeHtml
called by 24
functions/src/functions/express/express.ts
auth
called by 21
functions/src/smaregi/smaregiapi.ts
delete
called by 18
functions/src/smaregi/smaregiapi.ts
isNull
called by 15
src/utils/commonUtils.ts
validateData
called by 14
functions/src/lib/validator.ts

Shape

Function 444
Interface 70
Method 20
Class 10

Languages

TypeScript100%

Modules by API surface

src/utils/utils.ts72 symbols
functions/src/lib/validator.ts32 symbols
functions/src/lib/utils.ts26 symbols
src/models/functionTypes.ts24 symbols
functions/src/smaregi/smaregiapi.ts20 symbols
src/lib/firebase/analytics.ts15 symbols
functions/src/functions/express/express.ts13 symbols
src/utils/promotion.ts11 symbols
src/lib/pdf/pdf2.ts11 symbols
functions/src/smaregi/apiUtils.ts10 symbols
src/models/menu.ts9 symbols
functions/src/functions/notify2.ts9 symbols

For agents

$ claude mcp add ownplate \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page