584-scheduler

Scheduling application that written using Laravel and Vue.js

Table of Contents

• Installation
• API
  • TBD
• License

Installation

1. Clone the repository
2. Install PHP, Composer, and Node.js if needed
3. Make a copy of .env.example and rename it to .env
4. Fill out .env with correct information

• Make sure that lines 10 - 15 in point to the correct database name and credentials
  • If you are using XAMPP, you just need to create a new database named laravel
• Fill in the lines starting with GOOGLE_ with a valid Google OAuth 2.0 Client ID
  • These can be obtained by following the detailed instructions here.

5. Start up your SQL server
6. Run Setup Commands:

   $ php artisan key:generate
   $ composer install
   $ npm install
   $ php artisan migrate

   Or run this command for all of them at once:

   $ npm run setup

7. Commands for running the app:

   $ php artisan serve
   $ npm run watch

API

Section Name

Title

---

Description

• URL: /api/asdf
• Method: GET
• URL Params: none
• Body Params: none
• Authorization Params in header:

Authorization: ...

• Success Response:

  Code: 200

• Content:

• Error Responses:

  Code: 403 Forbidden, 401 UNAUTHORIZED, 400 BAD REQUEST

License

This project is currently unlicensed, but check again soon for updates!