Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnpapa/vue-typescript
Vue.js with TypeScript (OLD - in process of updating)
https://github.com/johnpapa/vue-typescript
nodejs typescript vue vue-router
Last synced: 19 days ago
JSON representation
Vue.js with TypeScript (OLD - in process of updating)
- Host: GitHub
- URL: https://github.com/johnpapa/vue-typescript
- Owner: johnpapa
- Created: 2017-11-05T04:17:33.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-12-02T22:28:20.000Z (almost 7 years ago)
- Last Synced: 2024-10-11T12:52:24.900Z (about 1 month ago)
- Topics: nodejs, typescript, vue, vue-router
- Language: Vue
- Homepage:
- Size: 917 KB
- Stars: 145
- Watchers: 12
- Forks: 48
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# vue-heroes
A Cosmos DB, Express.js, Vue, and Node.js app
## Features
This project framework provides the following features:
* Vue.js
* Node.js
* Express
* Mongoose API
* Connecting to MongoDB or CosmosDB
* Building, Debugging, Deploying with Docker
## Getting Started
### Prerequisites
Node.js with npm
### Installation
``` bash
git clone https://github.com/johnpapa/vue-heroes.git
cd vue-heroes
npm install
```
### Database settings
* Configure Cosmos DB server settings
Rename the `.env.example.js` file to `.env` in the root folder and update it with your Cosmos DB settings. Replace the accountName, databaseName, key, and port with your specific configuration.
```javascript
SERVER_PORT=3001
PUBLICWEB=./server/www
COSMOSDB_ACCOUNT=your_cosmos_account
COSMOSDB_DB=your_cosmos_db
COSMOSDB_KEY=your_cosmos_key
COSMOSDB_PORT=10255
```
### Quickstart
This will build the app and run the dev server for Vue and WebPack. The Node express server will launch and WebPack will proxy the calls from the browser to the API in express. It will also and prepare it for local debugging.
``` bash
# build for production with minification
npm run build
# serve on http://localhost:8080
# and run the api on http://localhost:3001
npm run debug
```
### Local Prod Build
This will build the app and launch via the Node.js express server.
```bash
# build for production with minification
npm run build
# run the node server
npm start
```
### Docker
Build the image and run container.
``` bash
npm run docker-up
```
Build the image and run container for local debugging.
``` bash
npm run docker-up-debug
```