From 91eca5fbd6d9b2561f81d844f73ffb034bd5a8a5 Mon Sep 17 00:00:00 2001
From: Jerrica Bobadilla <jbobadilla27@gmail.com>
Date: Mon, 19 Oct 2020 18:35:35 -0700
Subject: [PATCH] add installation and deployment guides

---
 README.md | 61 +++++++++++++++++++++++++++++++++----------------------
 1 file changed, 37 insertions(+), 24 deletions(-)

diff --git a/README.md b/README.md
index f057a98..3d03d32 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,37 @@
-# vue_contacts_frontend
-
-## Project setup
-```
-npm install
-```
-
-### Compiles and hot-reloads for development
-```
-npm run serve
-```
-
-### Compiles and minifies for production
-```
-npm run build
-```
-
-### Lints and fixes files
-```
-npm run lint
-```
-
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).
+# Contacts Frontend with Vue CLI  
+
+## Description 
+
+This is a frontend *only* vue app consuming a third-party API. In particular, this react app is consuming the Django REST API created [here](https://github.com/jlboba/django_rest_api), but this format will work for any seperate server API regardless of what language you built it in. 
+
+---
+
+## Get Set Up Locally 
+
+### On your Browser 
+
+1. Fork this repository to your account 
+
+### In your Terminal 
+
+1. Clone **your fork** of the repo onto your computer anywhere that is not a git repo
+1. `cd` into the repo 
+1. Touch a `.env` into the root of your project and add a VUE_APP_API_URL value wih the URL to your API. See the .env.sample file for an example of how to set it up
+    - Your URL can either be local if you're testing your local API or the deployed url if you're testing the deployed API 
+1.Install all the required packages by running: `npm install` 
+1. Run the app by running `npm run serve` and you should now be able to see the app on localhost:8080 
+
+### Etc. Notes 
+
+1. To change the title of the browser tab for your app, change it in the `vue.config.js` app 
+
+--- 
+
+## Deployment
+
+Deployment with Vue CLI is fairly straightforward. You can see the full deployment docs from Vue here and take your choice of where you want to deploy it, then follow their instructions: https://cli.vuejs.org/guide/deployment.html
+
+My suggestions for deployment, use either of these two: 
+
+- [Netlify](https://cli.vuejs.org/guide/deployment.html#netlify)
+- [Heroku](https://cli.vuejs.org/guide/deployment.html#heroku)