diff --git a/package.json b/package.json index efc8025..a572ca5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "koa-vue-notes-api", - "version": "1.0.1", + "version": "1.0.2", "description": "A SPA using Koa as the backend and Vue as the frontend.", "author": "John Datserakis", "private": false, diff --git a/readme.md b/readme.md index 04ed708..feeab5d 100644 --- a/readme.md +++ b/readme.md @@ -1,9 +1,33 @@ -# Koa-Vue-Notes-Api Project +
-This is a SPA using Koa (2.3) as the backend and Vue (2.3) as the frontend. There's more to this, but it is currently still in progress. You're welcome to take a look around as I get things set up. +# Koa-Vue-Notes-Api + +This is a simple SPA built using [Koa](http://koajs.com/) (2.3) as the backend and [Vue](https://vuejs.org/) (2.3) as the frontend. Click [here](https://github.com/johndatserakis/koa-vue-notes-web) to see the frontend Vue code. Work In Progress. -`npm run watch` +## Installing / Getting started + +``` bash +# install dependencies +yarn install + +# serve using nodemon with hot reload +npm run watch + +# build for production with prettier +npm run build + +# serve in production using the pm2 ecosystem.json file +npm run start-production +``` + +Note: Currently using yarn for the install due to the SendGrid node package requiring this at the moment. + +## Work In Progress + +Will update with more info shortly. + +## License -`npm run build ` \ No newline at end of file +[MIT](http://opensource.org/licenses/MIT) \ No newline at end of file diff --git a/src/static/koa-vue-notes-icon.png b/src/static/koa-vue-notes-icon.png new file mode 100644 index 0000000..282c559 Binary files /dev/null and b/src/static/koa-vue-notes-icon.png differ