petedannemann / neargreen-v2

Where finding healthy food, is a few steps away.

Neargreen V2

Goal

Near Green is a web application that aims to make healthy food accessible to the city of Philadelphia.

Features

• Single Page Application (SPA) where all requests are served by Django Rest Framework (DRF) and consumed by Vue.js

Backend Requirements

• Docker
• docker-compose

Frontend Requirements

• Yarn
• Vue Cli 3

Run Backend Development Server

$ docker-compose -f docker-compose.dev.yml build
$ docker-compose -f docker-compose.dev.yml up

Run Frontend Development Server

$ yarn serve

Run Backend Production Server

$ docker-compose -f docker-compose.prod.yml build
# The first time, seed the database, after that don't include that env var
$ SEED_DB=true SECRET_KEY=secretkey docker-compose -f docker-compose.prod.yml up

Deploy Frontend to Github Pages

$ source deploy_frontend.sh

URL Routes

/ Index, displays all stores

API Routes

/api/stores Display all stores

/api/stores/<storeid> Display a specific store

/api/register Register a profile

/api/auth/login Login a user

/api/auth/logout Logout a user