amanbarar / plate-pilot

A MERN based Restaurant Management web app.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


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

About

A MERN based Restaurant Management web app.


Languages

Language:JavaScript 93.1%Language:CSS 5.9%Language:HTML 0.9%Language:Less 0.2%