forked from johndatserakis/koa-vue-notes-api
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0ffa6bb
commit 1df1f3b
Showing
3 changed files
with
29 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.