JSDoc and Lerna scaffolding

client/.gitignore → .gitignore

@@ -1,7 +1,6 @@
 .DS_Store
 node_modules
-/dist
-
+dist
 /tests/e2e/videos/
 /tests/e2e/screenshots/
 
@@ -13,6 +12,7 @@ node_modules
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+lerna-debug.log
 
 # Editor directories and files
 .idea

README.md

@@ -46,16 +46,52 @@ These instructions will get you a copy of the project up and running on your loc
 
 ### Prerequisites
 
-If you don't have Nodejs and npm installed, install them from [here.](https://nodejs.org/en/)
+If you don't have Nodejs and npm installed, install them from [here.](https://nodejs.org/en/). You'll also want the Vue CLI tool, which you can install like this:
+
+```sh
+npm i -g @vue/cli
+```
 
 ### Installing and Running
 
-Clone this repository to your local machine, and in both the client and server directories:
+Clone this repository to your local machine and then:
 
 #### Install Dependencies
 
+In the root directory:
+
+```sh
+npm i
+```
+
 ```sh
-npm install
+npm run lerna-install
+```
+
+### Available Root Commands
+
+#### Compiles and minifies both server and client for production
+
+```sh
+npm run build
+```
+
+#### Start the server
+
+```sh
+npm run start
+```
+
+#### Run unit and integration tests
+
+```sh
+npm run test
+```
+
+#### Generate new docs
+
+```sh
+npm run jsdoc
 ```
 
 ### Available Client Commands
@@ -102,21 +138,23 @@ See [Configuration Reference](https://cli.vuejs.org/config/).
 npm run dev
 ```
 
-#### Start the server
+#### Build the server
 
 ```sh
-npm run start
+npm run build
 ```
 
-## Deployment
-
-After forking the project and setting up the cloud database and .env file as per the above steps, add your forked repo to Travis CI [here.](https://travis-ci.com/getting_started) After that, setup a Heroku instance following the guide [here,](https://devcenter.heroku.com/articles/getting-started-with-nodejs) add your environment variables with the Heroku dashboard, and add your api-key and app name to the .travis.yml file.
+#### Start the server
 
-Congrats! Now everytime you push to master, you'll automatically check that installing and building works and then deploy if it does.
+```sh
+npm run start
+```
 
 ## Built with
 
 - [Vue](https://vuejs.org/) - Front-end framework
+- [D3.js]()
+- [Lerna](https://www.lerna.js.org) - Tool for managing multiple packages
 - [TypeScript](https://typescriptlang.org) - Javascript superset to add type checking
 - [axios](https://github.com/axios/axios) - Promise-based HTTP client
 - [Sass](https://sass-lang.com/) - CSS pre-compiler to make styling easier
@@ -125,7 +163,6 @@ Congrats! Now everytime you push to master, you'll automatically check that inst
 - [PostgreSQL](https://www.postgresql.org/) - Open source object-relational database
 - [Jest]()
 - [Cypress]()
-- [D3.js]()
 - []()
 
 ## Contributing
@@ -148,7 +185,7 @@ Bryce McMath – [bryce-mcmath](https://github.com/bryce-mcmath) – bryce.j.mcm
 
 - Bugs? What bugs?
 
-_To add an issue, start a new one [here.](https://github.com/bryce-mcmath/foodzebra/issues)_
+_To add an issue, start a new one [here.](https://github.com/bryce-mcmath/traderu/issues)_
 
 ## Feature roadmap
 

client/jsdocs.json

@@ -0,0 +1,10 @@
+{
+  "source": {
+    "exclude": ["./dist", "./node_modules"]
+  },
+  "opts": {
+    "encoding": "utf8",
+    "recurse": true,
+    "destination": "../docs/jsdoc/client"
+  }
+}

client/package.json

@@ -8,7 +8,9 @@
     "build": "vue-cli-service build",
     "test:unit": "vue-cli-service test:unit",
     "test:e2e": "vue-cli-service test:e2e",
-    "lint": "vue-cli-service lint"
+    "test":"npm run test:unit",
+    "lint": "vue-cli-service lint",
+    "jsdoc": "./node_modules/.bin/jsdoc . -c ./jsdocs.json -R ../README.md"
   },
   "repository": {
     "type": "git",
@@ -65,7 +67,8 @@
     "prettier": "^1.19.1",
     "sass-loader": "^8.0.2",
     "typescript": "~3.7.5",
-    "vue-template-compiler": "^2.6.11"
+    "vue-template-compiler": "^2.6.11",
+    "jsdoc": "^3.6.3"
   },
   "author": "Jonathan Langlois, Wilson Wong, Bryce McMath",
   "license": "ISC",