From ab05ad949871cdf2273ad09b34522e2903640eb5 Mon Sep 17 00:00:00 2001 From: PLJNS Date: Tue, 19 Mar 2024 22:34:10 -0400 Subject: [PATCH] Update README --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index df6260dd..f840f0c4 100644 --- a/README.md +++ b/README.md @@ -1 +1,19 @@ -# MyOrderApp Backend +# MyOrderApp Back-end + +> Transform your Square POS setup into a powerful mobile ordering platform with MyOrderApp. Just use Square the way you already do, and trust us to provide an exceptional mobile ordering experience for your customers. The platform features immediate synchronization with your Square Catalog and Locations, ensuring your app is always up-to-date. Effortlessly manage and rearrange your catalog’s categories, items, and variations whenever you wish. + +This is the back-end for MyOrderApp, allowing Sellers to manage their app, and Customers to make purchases, all through Square. + +This is a Nest.js project bootstrapped using Brocoders template. + +## How to use + +Install dependencies and run: + +```bash +npm install +cp env-example .env +npm run dev +``` + +Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. \ No newline at end of file