Merge branch 'master' of github.com:gwenf/curriculum-app

README.md

@@ -6,15 +6,31 @@ To see the playlist where I livestream the building of this app, [click here](ht
 
 ## Table of Contents
 
+1. [Running Locally](#running-locally)
+1. [Tech Stack](#tech-stack)
 1. [Mockups](#mockups)
-1. [Schema](#schema)
 1. [Routes](#routes)
-1. [Running Locally](#running-locally)
+1. [Schema](#schema)
+1. [API](#api)
 1. [MVP Features](#mvp-features)
 1. [Version 1 Features](#version-1-features)
-1. [Tech Stack](#tech-stack)
 1. Initial, Front-end TODOs
 
+## Running Locally
+
+1. Clone this repo
+1. `cd curriculum-front`
+1. `npm i`
+1. `npm run serve`
+
+## Tech Stack
+
+1. Vue.js/Vue Router/Vuex
+1. Vuetify
+1. Node.js/Express.js
+1. MongoDB/Mongoose (subject to change)
+1. Digital Ocean (hosting)
+
 ## Mockups
 
 <p align="center">
@@ -29,6 +45,14 @@ To see the playlist where I livestream the building of this app, [click here](ht
   <img src="https://github.com/gwenf/curriculum-app/blob/master/Display%20Curriculum.png" alt="Display Curriculum Page Mockup">
 </p>
 
+## Routes
+
+* / --> Home Page/Landing Page
+* curricula --> shows all curricula
+* curricula/create --> shows form to create
+* curricula/id --> shows single curriculum
+* curricula/id/update --> update single curriculum
+
 ## Schema
 
 **curricula**
@@ -44,20 +68,22 @@ To see the playlist where I livestream the building of this app, [click here](ht
 * createdAt: timestamp
 * updatedAt: timestamp
 
-## Routes
+## API
 
-* / --> Home Page/Landing Page
-* curricula --> shows all curricula
-* curricula/create --> shows form to create
-* curricula/id --> shows single curriculum
-* curricula/id/update --> update single curriculum
+**Prefix:** `/api/v1`
 
-## Running Locally
+**Endpoints:**
 
-1. Clone this repo
-1. `cd curriculum-front`
-1. `npm i`
-1. `npm run serve`
+`/curricula`
+
+* get
+* post
+
+`/curricula/:id`
+
+* get
+* patch
+* delete
 
 ## MVP Features
 
@@ -69,20 +95,3 @@ To see the playlist where I livestream the building of this app, [click here](ht
 
 1. Users can log in and save their curricula
 1. Users can fork other users curricula
-
-## Tech Stack
-
-1. Vue.js/Vue Router/Vuex
-1. Vuetify
-1. Node.js/Express.js
-1. MongoDB/Mongoose (subject to change)
-1. Digital Ocean (hosting)
-
-## Front-end/initial TODOs
-
-1. Map out schema
-1. Set up front-end
-1. Create home page
-1. Create curriculum view page
-1. Create curriculum form page
-