Description

🍴 Front-End app for Soupify. Written with Vue.js using Vuetify and Vuex 🍟

---

Linked Repositories

• Back-end Server - or find server HERE
• API Specification v1.2

---

📃 Documentation

• OpenApi 3 Specification - files in API folder
• Vue Live Application
• Heroku Live Server
• Default Users:
  • Admin - root: toor!1

---

⚠️ Prerequisites

You need to have installed the following software:

• Vue.js (>=2.6.11)
• npm (>= 6.13.0)

📦 How To Install

You can modify or contribute to this project by following the steps below:

1. Clone the repository

• Open terminal ( Ctrl + Alt + T )

• Clone to a location on your machine.

  # Clone the repository
  $> git clone https://github.com/serfati/soupify.git
  
  # Navigate to the directory
  $> cd soupify

2. Setup

• Install npm packages in project directory

  $> npm install

3. Run Locally

# run server
$> npm run serve

# open your browser at port 8080
$> google-chrome http://localhost:8080/

• Or just click here: http://localhost:8080/

Dependencies and Main Packages

• vue - progressive js framework
• vuex - state management
• vuetify - design component framework
• axios - HTTP requests
• other dependencies you can see in package.json

📜 Scripts:

• serve - Run whole application
• build - Build application
• loadData - Load the latest countries and foods data
• deploy - App deploy to gh-pages branch

---

⚖️ License

• MIT license
• Copyright 2020 © serfati.

⬆ back to top