wbpmrck / web-starter

a website skeleton which using most popular web framework and skills.speed up normal development.

web-starter

a website skeleton which using most popular web framework and skills.speed up normal development.

install

first go to project dir and install dependencies:

$ npm install

and run the script:

$ ./run.debug.sh

if succeed,you will see some outputs:

prepare staring service in [dev] mode,has debug log
INFO 14634: =====准备自动注册路由======
服务已启动，端口:[1234]
INFO 14634: --->正在注册controller:[/your dir/web-starter/app/controllers/index.js]
INFO 14634: -------->注册 action:[GET][/login]
INFO 14634: -------->注册 action:[GET][/]
INFO 14634: --->正在注册controller:[/your dir/web-starter/app/controllers/sys.js]
INFO 14634: -------->注册 action:[POST][/sys/addSysParam]
INFO 14634: -------->注册 action:[GET][/sys/getConfig]
INFO 14634: --->正在注册controller:[/your dir/web-starter/app/controllers/user.js]
INFO 14634: -------->注册 action:[GET][/user/regist/:accountName/:password]
INFO 14634: -------->注册 action:[GET][/user/login/:accountName/:password]
INFO 14634: -------->注册 action:[GET][/user/logout]
INFO 14634: -------->注册 action:[GET][/user/getLoginUser]
INFO 14634: =====路由注册完毕======

file structure

./app

the main dir of the web

• controllers

  • the controller of the web

• dao

  • the data access objects of the web

• helper

  • some utils

• interceptors

  • interceptor deal with each request,some before the controller,some after it.

• log

  • the log helper

• routes

  • the routes automation logic.

  you don't need to update this file

• service

  • services call dao to complete business ops.

• views

  • view is server template,put them here.

• static

  • static files here can be visite from http.

./config

here stays the configurations files.

./framework

the common utils/libs used by the web site.

docs

the project have some rules that make code simple,see below articles for more details:

• How Router works
• template api
• How Interceptor works
• CRUD with ORM
• user and roles

test

start server

because it's a web site,so you should start it first:

$ ./run.debug.sh

run mysql

• install mysql in your machine
• create db instance in your mysql service.

take care of the db name and user account.must consist in your configs in ./config/default.js

db :{
        modelPath: require('path').join(__dirname, '../app/dao/models/generated'),
        db: 'pitaya',
        username: 'root',
        password: 'kaicui',
        dialect: 'mysql',
        host: '127.0.0.1',
        port: 3306,
        pool: {
            maxConnections: 10,
            minConnections: 0,
            maxIdleTime: 30000
        }
    }

• execute the .sql files in docs dir

run test command and see result

we use mocha to test. the test command is simple:

$ npm test

and you can see the shell output of the test script.

todo

see todo list

about front-end

• if your project is complicated,we suggest use single project to manage FE codes.
• you can check web-starter-front-end,its a front-end skeleton built for fast development