Merge pull request #12 from vowaid/11-readme

[#11] Add basic readme & update gitignore for additional files

.gitignore

@@ -82,3 +82,27 @@ dist
 
 # Service worker
 sw.*
+
+# Dependencies
+/node_modules
+
+# Testing
+/coverage
+
+# Production
+/build
+
+# Misc
+.vscode
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Custom
+package-lock.json

readme.md

@@ -0,0 +1,43 @@
+# Veterans of War Aid Foundation
+
+## Table of Contents
+
+- [Requirements](#requirements)
+- [Getting Started](#getting-started)
+- [Testing](#testing)
+- [Deployment](#deployment)
+
+## Requirements
+
+- [npm](https://www.npmjs.com/get-npm)
+- Understand the [GitFlow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)
+    >This is the workflow we utilize across the project for branching method.
+
+## Getting Started
+
+1. Install packages
+
+    ```bash
+    npm i
+    ```
+
+2. Start project
+
+    ```bash
+    npm run dev
+    ```
+
+3. The application is now running on http://localhost:3000.
+
+    >Nuxt.js will listen for file changes inside the pages directory, so there is no need to restart the application when adding or updating pages.
+
+## Testing
+
+**Coming Soon (TODO)**
+
+## Deployment
+
+Deployments will occur automtically with merges into `master`. Merges into master should be limited to specific release branches or hotfixes, as needed.
+
+- Redesign deployments will need to occur in more wholistic updates.
+- Performance or tech debt improvements can occur more individually.