yaep: Yet Another Express Project

requirements

• express
• twig
• pm2

installation

• to start with yaep do:

git clone [email protected]:AndrewCherabaev/yaep.git
cd yaep
npm i
npm start

• after npm start pm2-process will started and you can see everything by pm2 ls
• default config for pm is:

apps:
  - script:       ./bin/www
    name:         yaep
    exec_mode:    fork
    autorestart:  true
    watch:        true
    instances:    1
    merge_logs:   true
    error_file:   './logs/error.log'
    out_file:     './logs/access.log'
    env:
      PORT:       3000
      NODE_PATH:  './app'

last line in env params helps me to require modules from app root like require('controllers/index') and not like require('./../controllers/index')

about

it's really "Yet Another EpressJS project"

it's build on top of epressjs and uses pm2 as process manager

i can say i try to write yet another application does everything at all

future plans

in general, future plans is to add some useful (really useful) modules as much as possible

nodules

yes, because i mean 'node modules'

• move everything the app folder new project root app/
• express-session for sessions
• nedb or lowdb for something use lowdb as default driver. nedb not works fine for me
• joi for validator joi used for validating requests
• connect-flash connect-flash for flash messages
• passport.js for auth
• socket.io for websockets
• sequelize for databases
• knex plus bookshelf for query builder
• finale for RESTify models
• elasticsearch-js for elasticsearch
• i18n for internationalisation
• webpack for building
• bower for browser libraries
• dotenv or dotenv-safe for environment
• lodash or underscore for functional
• babel-cli and babel-preset-env for import ... from and exports ES6 fetures; or not

features

• admin panel
• CMS with built-in editior
• CLI application yaep for generating some
  • published as yaep-consolidator foreign module
• bootstrap/foundation/semantic-ui/material, fa for frontent design

trouleshooting

pm2 logs have ANSIColor format and --no-color flag still not works properly

so for SublimeText 3, should you choose to use it, needs to install this ANSI format plugin

after that you can open *.log files in SublimeText 3 and do View -> Syntax -> ANSI to see well-formated logs