Skip to content

Commit

Permalink
updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
johndatserakis committed Aug 16, 2017
1 parent 0ffa6bb commit 1df1f3b
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 5 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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,
Expand Down
32 changes: 28 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,33 @@
# Koa-Vue-Notes-Api Project
<p align="center"><a href="https://vuejs.org" target="_blank"><img width="200" src="./src/static/koa-vue-notes-icon.png"></a></p>

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 `
[MIT](http://opensource.org/licenses/MIT)
Binary file added src/static/koa-vue-notes-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1df1f3b

Please sign in to comment.