/mealSocial

Class project: A Vue.js Application for meal planning and sharing those meals with others.

Primary LanguageVue

mealSocial Vue.js app

Demo: http://35.197.8.81:8080 (You can "Register" a new account) (Archived Video Demo)

Setup Step 1: Prepare Environment Variables (Required)

  1. Change the name of /server/.env.example to .env by running mv server/.env.example server/.envand edit the NODE_ENV and/or PORT if you wish. (No changes necessary for simple local testing.)

  2. Change the name /app/.env.example to .env and edit the HOST and/or PORT if you wish. (No changes necessary for simple local testing.)

Setup Step 2a: Run in Docker (Option 1)

  1. Install Docker on your host machine.

[ https://docs.docker.com/get-docker/ ]

  1. In a PowerShell/terminal, cd to the project root directory (where docker-compose.yml is) and run :

docker-compose up --build

  1. The docker-compose will spin up the backend server, followed by the frontend server.

  2. Wait until the frontend portion of the docker-compose completes. The final message displayed in PowerShell/terminal should be:

frontend_1  |   App running at:
frontend_1  |   - Local:   http://localhost:8080/
frontend_1  |
frontend_1  |   It seems you are running Vue CLI inside a container.
frontend_1  |   Access the dev server via http://localhost:<your container's external mapped port>/
frontend_1  |
frontend_1  |   Note that the development build is not optimized.
frontend_1  |   To create a production build, run npm run build.
  1. Once the above message is displayed, navigate to localhost:8080 in a web browser on your host machine.

Shut Down

In a new PowerShell/terminal, navigate to the project root directory (where docker-compose.yml is) and run: docker-compose down

Setup Step 2b: Set up for Local Development (Option 2)

Install dependancies

  1. In a PowerShell/terminal, cd to /server/ and run npm install to install the backend dependancies.

  2. In a PowerShell/terminal, cd to /app/ and run npm install to install the frontend dependancies.

Run the app

  1. Backend: cd to /server/ and run node index.js.

  2. Frontend: cd to /app/ and run npm run dev.