Skip to content

Latest commit

 

History

History
93 lines (63 loc) · 3.12 KB

README.md

File metadata and controls

93 lines (63 loc) · 3.12 KB

https://github.com/Keelan-Matthews/vue-project/blob/master/README.md

IMY 210 Vue Project 2022

This repository contains a final Vue project that had to be completed for one of my second year modules. We were tasked with creating a fully-fledged scheduling application, utilizing all of the skills that we were taught throughout the semester. The specification required 5 preset users, each with their own schedule.

Table of Contents
  1. Built With
  2. Getting Started
  3. Usage
  4. Contact

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g

Installation

  1. Install NPM packages (Do this in both the RESTful directory, as well as the Vue directory)
    npm install

(back to top)

Usage

On startup, no calendar or user will be selectetd. You will need to select a calendar to display it, as well as the user of that calendar if you wish to edit it. You may however view any calendar you wish - you just will not be able to edit it if you are not signed in as the user.

Clicking on an event will display a summary of all its information, as well as an option to delete or edit the description of the event (I felt the description edit was more than enough to show the Update functionality of my server - more complex fetch requests are showcased in the Create request).

There is also an add event in the top right, keep in mind the starred fields are compulsory - this includes the starting and ending time despite the XML database requirements.

Lastly, you can change the view of the calendar from month to week to day etc. Also, the XML database specification did not supply a year field in the date section, so all repeating events end in 2022 and all events are automatically made in 2022.

Happy marking :)

(back to top)

Contact

Keelan Matthews - u21549967@tuks.co.za
Student Number - u21549967

(back to top)