https://github.com/vugga/vuga-template
Web App template with ExpressJS, MongoDB, Socket.IO and Redis
https://github.com/vugga/vuga-template
expressjs mongoose redis socket-io typescript
Last synced: 2 months ago
JSON representation
Web App template with ExpressJS, MongoDB, Socket.IO and Redis
- Host: GitHub
- URL: https://github.com/vugga/vuga-template
- Owner: vugga
- Created: 2019-01-31T18:55:51.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-31T18:57:47.000Z (over 7 years ago)
- Last Synced: 2025-04-10T05:46:18.087Z (about 1 year ago)
- Topics: expressjs, mongoose, redis, socket-io, typescript
- Language: TypeScript
- Size: 2.24 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Vuga template app
This is an app template to work on NodeJS+Express+Socket.IO+Redis written in TypeScript. app includes tests aswell
# To run
Get started developing...
```shell
# install deps
npm install
# run in development mode
npm run dev
# run tests
npm run test
```
---
## Install Dependencies
Install all package dependencies (one time operation)
```shell
npm install
```
## Run It
#### Run in *development* mode:
Runs the application is development mode. Should not be used in production
```shell
npm run dev
```
or debug it
```shell
npm run dev:debug
```
#### Run in *production* mode:
Compiles the application and starts it in production production mode.
```shell
npm run compile
npm start
```
## Test It
Run the Mocha unit tests
```shell
npm test
```
or debug them
```shell
npm run test:debug
```
## Try It
* Open you're browser to [http://localhost:3000](http://localhost:3000)
* Invoke the `/examples` endpoint
```shell
curl http://localhost:3000/api/v1/examples
```
## Debug It
#### Debug the server:
```
npm run dev:debug
```
#### Debug Tests
```
npm run test:debug
```