ryarturogi / foodies-burger-restaurants

Foodies a restaurant locator and digital menu

Explore the docs »
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Acknowledgements
4. Contact

About The Project

A famous hamburger restaurant app for searching near store locations and a dynamic hamburgers menu where you can find the perfect hamburger for you belly.

Built With

• VueJs
• NuxtJs
• Nodejs
• Yarn
• Bootstrap 4
• MapBox API
• AOS Animations

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Install Yarn - doc: https://www.yarnpkg.com/

• Check if Yarn is installed

$ yarn --v

Installation

Docker

You can use docker to pull an image of entire project fully dockerize

Foodies Docker Hub

or you can clone the repo from Github

Github

1. Clone the repo from Github

$ git clone https://github.com/ryarturogi/foodies-elaniin.git

2. Install dependencies

# install dependencies with yarn
$ yarn install

# serve with hot reload at localhost:3000
$ yarn dev

# build for production and launch server
$ yarn build
$ yarn start

# generate static project
$ yarn generate

Acknowledgements

Environment Variables

• ELANIIN_API_PATH
• MAPBOXAPI
  • Doc: https://docs.mapbox.com/

Things you may want to cover:

• VueJs version 2
• NuxtJs version 2.14+

Contact

© 2021 Ricardo A. Guillen. [e-mail]