Giter Club home page Giter Club logo

gk-pos-file-sync's Introduction

Ghost Kitchen - File Sync

A console app that downloads menu and order files.

NodeJS TypeScript NestJS AWS Vercel PKG

Table of contents

Prerequisites

Tools

  • Node.js v18.19.0
  • Yarn 1.22.19

Config

Create a copy of src/app/env.example.json named env.json and set the correct values. Alternatively, you can ask other contributors for the file.

Usage

Install dependencies

yarn # shorthand for `yarn install`

Run in development mode

yarn start:dev

Create executable file for Windows

yarn pkg:win # Outputs `pkg/win.exe`

Create executable file for macOS

yarn pkg:mac # Outputs `pkg/mac`

File Download

Files will be saved under files folder.

Menu

  • files/menu.csv
  • Downloaded via a cron job. The file is redownloaded every minute.

Order

  • files/orders/ORDER_1106.xml
  • Downloaded via AWS SQS.

AWS SQS

The following queues must be created in order for the app to run:

download-order-file

{
  "url": "https://some-bucket.s3.us-west-2.amazonaws.com/gk-files/ORDER_1106.xml",
  "fileName": "ORDER_1106.xml"
}

Also see: sqs-names.ts

gk-pos-file-sync's People

Contributors

siongesteban avatar ssengalanto avatar dependabot[bot] avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.