Giter VIP home page Giter VIP logo

plate-pilot's Introduction


PLATE PILOT

Restaurant Management App.

Table of Contents
  1. About The Project
  2. Getting Started
  3. License
  4. Contact
  5. Acknowledgements
  6. Preview

About the Project

Restaurant Management App made with NodeJS, Express, MySQL, ReactJS and Redux.

Built With

Getting Started

There are two ways to start this project. The first one which needs some configuration and the easy one, with docker.

Installation

  1. Clone the repo

    git clone https://github.com/matias-rivera/restobar.git
  2. You will need to install a Mysql Server, i think that WAMP is an easy tool to get started. Then create a database.

  3. Go to "backend", install the dependencies.

    npm install

    Open ".env.example", set the database variables, then change the file name to ".env"

     NODE_ENV=development
     PORT=5000
     JWT_SECRET=[YOUR SECRET]
     DB_USER=[DATABASE USER]
     DB_NAME=[DATABASE NAME]
     DB_PASSWORD=[DATABASE PASSWORD]
     DB_HOST=[DATABASE HOST]
     DB_DIALECT=mysql
    

    Fill the database. These commands will make the work. The first one creates the structure, the second fills the database with some initial data.

        npx sequelize-cli db:migrate
        npx sequelize-cli db:seed:all
  4. RUN

    npm run dev
  5. Now, go to "frontend". Install the dependencies

    npm install

    You will need to set a proxy, open package.json and write this. More information about proxies here.

    "proxy": "http://localhost:5000"
  6. RUN

    npm start

Run with Docker

  1. Install Docker. More information here.

  2. Clone the repo

    git clone https://github.com/matias-rivera/restobar.git
  3. Run Docker compose

    docker-compose up --build
  4. It should start at "localhost:3000".

Acknowledgements

plate-pilot's People

Contributors

amanbarar avatar

Stargazers

 avatar Nitin Dhakad 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.