This project's target is to helper people to create a Reactivity, Realtime, User friendly backend system.
Mongodb
This project requiremongodb
as the db store, you can follow it's tutorial to install if you do not installed.- Base
vue
skills
If you don't choose i18n when project initialization, you need to take a look at this description, or you can skip this step.
As vue-cli
does't support more ablity to run task after init, so you need to run npm run remove:i18n
manually. This script doesn't change the page view which contains change locale
in /client/src/components/Header.vue
, you can remove those code manually.
This is a project template for vue-cli. It is recommended to use npm 3 for a more efficient dependency tree.
# cli version must greater than 2.5.0
$ npm install -g vue-cli
$ vue init erguotou520/vue-fullstack my-project
$ cd my-project
$ npm install
# If you choose not to use vue-i18n, you need to run remove:i18n to replace the file with default locale text. If you have chosen vue-i18n, skip this step
$ npm run remove:i18n
# This runs a express server
$ npm run server
# Open other terminal and cd into my-project
# This runs a frontend dev server
$ npm run client
vue
vue-router
vuex
vue-i18n
vue-resource
element-ui
express
mongoose
socket.io
Here is a demo and the demo repo is here
This is other one
username: admin
password: admin
├─client # frontend source folder
│ ├─build # frontend dev scripts
│ ├─src # frontend src
│ │ ├─assets
│ │ │ ├─css
│ │ │ ├─fonts
│ │ │ └─images
│ │ ├─components # vue components
│ │ ├─http # vue-resource configuration
│ │ ├─locale # vue-i18n configuration
│ │ ├─router # vue-router configuration
│ │ ├─socket # socket.io configuration
│ │ ├─storage # web storage api
│ │ ├─store # vuex store
│ │ │ └─modules
│ │ └─view # app pages
│ │ └─auth
│ └─static # static folder
└─server # backend server folder
├─api # backend api list
│ ├─thing
│ └─user
├─auth # user auth logical
│ └─local
├─components # server components
│ └─errors
├─config # server configs, contains express socket.io, etc.
└─views # server servered pages
Most of the configuration is concentrated in the config.js
file, and most of them have explicit comments, you need to take a look at it first.
Here is some important/frequently-used configuration:
frontend.port
port that frontend server listens atbackend.port
port that backend server listen atbackend.secrets.session
secret for session, important when you deploy your app, make sure it's complex enoughbackend.mongo.uri
change this if your mongodb uri is not matchedbackend.serverFrontend
whether to server the frontend code. If set totrue
the express server servers the frontend code, otherwise you may need a http server like nginx to server frontend code and there is a nginx configuration atnginx.example.conf
(default true)
When you deploy your app to you cloud server, it's easy to config you app with environment variable
, here is the supported:
APP_port
orPORT
: set tobackend.port
APP_HOST
orAPP_IP
orHOST
orIP
: set tobackend.ip
MONGODB_URI
orMONGOHQ_URI
: set tobackend.mongo.uri
SECRET
: set tobackend.secrets.session
The generated app is just a template to build your app system fast, maybe it can't meet your needs, so you need to do some change at this issue.
Under MIT license
I am very glad to receive your suggestions and pull request.