add installation and deployment guides

README.md

@@ -1,24 +1,37 @@
-# vue_contacts_frontend
+# Contacts Frontend with Vue CLI  
-
+
-## Project setup
+## Description 
-```
+
-npm install
+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. 
-```
+
-
+---
-### Compiles and hot-reloads for development
+
-```
+## Get Set Up Locally 
-npm run serve
+
-```
+### On your Browser 
-
+
-### Compiles and minifies for production
+1. Fork this repository to your account 
-```
+
-npm run build
+### In your Terminal 
-```
+
-
+1. Clone **your fork** of the repo onto your computer anywhere that is not a git repo
-### Lints and fixes files
+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
-npm run lint
+    - 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 
-### Customize configuration
+
-See [Configuration Reference](https://cli.vuejs.org/config/).
+### 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)