README.md

Fast Agenda Maker

A responsive calendar for spontaneous individuals who also
have a structured approach to their daily agendas.

Live Demo - https://fast-agenda.herokuapp.com/

Key Features

• Seven unique restaurants generated for each day of the week automatically placed on the calendar
• Input any form of location to get food choices (zip code, city, state, latitude and longitude or any legible address)
• Search and select from 40 different food categories
• Seperate "Add an Event" interface from calendar viewer to add, update, and delete events
  • Restaurant events load asynchronously from Yelp HTTPS request
• Final planner displays a calendar with all personal and restaurant events merged together
  • Ability to drag and drop events to adjust event times while persisting data through each page

(back to top)

Built With

• Svelte - Web framework
  • JavaScript - Language used within Svelte
• Yelp Fusion API - For fetching restaurants
• Heroku - PaaS for Hosting CORS Redirect
• svelte-fullcalendar - wrapper of JavaScript FullCalendar

Hide Images

(back to top)

Getting Started

Run this project within your own environment.

Prerequisites

• Install Node.js (includes npm) - https://nodejs.org/en/download/

Installation

1. Clone the repo

   git clone https://github.com/vineet2420/PlanMyDay.git
   

   or w/ ssh

   git clone git@github.com:vineet2420/PlanMyDay.git
   

2. Change directories

   cd PlanMyDay/main/
   

3. Run the application locally

   npm run dev
   

4. Open the full address and port in a web browser, most likely:

   http://localhost:5000/
   

(back to top)

Configuration

Add API Key

1. Go to https://www.yelp.com/developers/documentation/v3/get_started and create an app with the Yelp Fusion API.

2. Paste the API key in the header of makeRequest() located in:

   PlanMyDay/main/src/foodSelectionManager.js
   

   (line 13)

   Note: this is not the best practice for production applications but is suitable for our development environment

(back to top)