обновление (2013-10-29): пожалуйста, смотрите мой другой ответ, а также который имеет JavaScript вместо CoffeeScript по популярному требованию, а также шаблонный GitHub repo и обширный README с подробным описанием моих последних рекомендаций по этой теме.

Config

то, что вы делаете хорошо. Мне нравится иметь собственное пространство имен config, настроенное на верхнем уровне config.coffee файл с вложенным пространством имен, как это.

#Set the current environment to true in the env object
currentEnv = process.env.NODE_ENV or 'development'
exports.appName = "MyApp"
exports.env =
  production: false
  staging: false
  test: false
  development: false
exports.env[currentEnv] = true
exports.log =
  path: __dirname + "/var/log/app_#{currentEnv}.log"
exports.server =
  port: 9600
  #In staging and production, listen loopback. nginx listens on the network.
  ip: '127.0.0.1'
if currentEnv not in ['production', 'staging']
  exports.enableTests = true
  #Listen on all IPs in dev/test (for testing from other machines)
  exports.server.ip = '0.0.0.0'
exports.db =
  URL: "mongodb://localhost:27017/#{exports.appName.toLowerCase()}_#{currentEnv}"

это удобным для редактирования системного администратора. Затем, когда мне что-то нужно, например, информация о подключении к БД, это

require('./config').db.URL

Маршруты/Контроллеры

мне нравится оставлять свои маршруты с моими контроллерами и организовывать их в app/controllers поддиректории. Затем я могу загрузить их и позволить им добавить любые маршруты, которые им нужны.

в своем app/server.coffee файл coffeescript я делаю:

[
  'api'
  'authorization'
  'authentication'
  'domains'
  'users'
  'stylesheets'
  'javascripts'
  'tests'
  'sales'
].map (controllerName) ->
  controller = require './controllers/' + controllerName
  controller.setup app

поэтому у меня есть такие файлы, как:

app/controllers/api.coffee
app/controllers/authorization.coffee
app/controllers/authentication.coffee
app/controllers/domains.coffee

и например в мой контроллер доменов, у меня есть setup функции как этот.

exports.setup = (app) ->
  controller = new exports.DomainController
  route = '/domains'
  app.post route, controller.create
  app.put route, api.needId
  app.delete route, api.needId
  route = '/domains/:id'
  app.put route, controller.loadDomain, controller.update
  app.del route, controller.loadDomain, exports.delete
  app.get route, controller.loadDomain, (req, res) ->
    res.sendJSON req.domain, status.OK

вид

ввод просмотров в app/views становится привычным местом. Я изложил это так.

app/views/layout.jade
app/views/about.jade
app/views/user/EditUser.jade
app/views/domain/EditDomain.jade

Статические Файлы

поехать в public поддиректории.

Github / Semver / NPM

положите README.файл MD markdown в корневом каталоге git repo для github.

поставить пакет.файл json с семантический версия номер в корне репозитория git для NPM.

ниже приведен ответ Питера Лайонса дословно, перенесенный на vanilla JS из Coffeescript, как просили несколько других. Ответ Питера очень способный, и любой, кто голосует за мой ответ, должен голосовать и за его.

Config

то, что вы делаете хорошо. Мне нравится иметь собственное пространство имен config, настроенное на верхнем уровне config.js файл с вложенным пространством имен, как это.

// Set the current environment to true in the env object
var currentEnv = process.env.NODE_ENV || 'development';
exports.appName = "MyApp";
exports.env = {
  production: false,
  staging: false,
  test: false,
  development: false
};  
exports.env[currentEnv] = true;
exports.log = {
  path: __dirname + "/var/log/app_#{currentEnv}.log"
};  
exports.server = {
  port: 9600,
  // In staging and production, listen loopback. nginx listens on the network.
  ip: '127.0.0.1'
};  
if (currentEnv != 'production' && currentEnv != 'staging') {
  exports.enableTests = true;
  // Listen on all IPs in dev/test (for testing from other machines)
  exports.server.ip = '0.0.0.0';
};
exports.db {
  URL: "mongodb://localhost:27017/#{exports.appName.toLowerCase()}_#{currentEnv}"
};

это дружелюбно для sysadmin редактирование. Затем, когда мне что-то нужно, например, информация о подключении к БД, это

require('./config').db.URL

Маршруты/Контроллеры

мне нравится оставлять свои маршруты с моими контроллерами и организовывать их в app/controllers поддиректории. Затем я могу загрузить их и позволить им добавить любые маршруты, которые им нужны.

в своем app/server.js JavaScript-файл я делаю:

[
  'api',
  'authorization',
  'authentication',
  'domains',
  'users',
  'stylesheets',
  'javascripts',
  'tests',
  'sales'
].map(function(controllerName){
  var controller = require('./controllers/' + controllerName);
  controller.setup(app);
});

поэтому у меня есть такие файлы, как:

app/controllers/api.js
app/controllers/authorization.js
app/controllers/authentication.js
app/controllers/domains.js

и, например, в моем контроллере доменов, I есть setup функции как этот.

exports.setup = function(app) {
  var controller = new exports.DomainController();
  var route = '/domains';
  app.post(route, controller.create);
  app.put(route, api.needId);
  app.delete(route, api.needId);
  route = '/domains/:id';
  app.put(route, controller.loadDomain, controller.update);
  app.del(route, controller.loadDomain, function(req, res){
    res.sendJSON(req.domain, status.OK);
  });
}

вид

ввод просмотров в app/views становится привычным местом. Я изложил это так.

app/views/layout.jade
app/views/about.jade
app/views/user/EditUser.jade
app/views/domain/EditDomain.jade

Статические Файлы

поехать в public поддиректории.

Github / Semver / NPM

положите README.файл MD markdown в корневом каталоге git repo для github.

поставить пакет.файл json с семантический версия номер в корне репозитория git для NPM.

мой вопрос был внесен в апреле 2011 года, это тихий старый. За это время я мог бы улучшить свой опыт работы с Express.js и как создать архитектуру приложения, написанного с помощью этой библиотеки. Итак, я делюсь здесь своим опытом.

вот моя структура каталогов:

├── app.js   // main entry
├── config   // The configuration of my applications (logger, global config, ...)
├── models   // The model data (e.g. Mongoose model)
├── public   // The public directory (client-side code)
├── routes   // The route definitions and implementations
├── services // The standalone services (Database service, Email service, ...)
└── views    // The view rendered by the server to the client (e.g. Jade, EJS, ...)

App.js

цель app.js файл для загрузки приложения expressjs. Он загружает модуль конфигурации, модуль регистратора, ждет базу данных соединение. ,.., и запустите экспресс-сервер.

'use strict';
require('./config');
var database = require('./services/database');
var express = require('express');
var app = express();
module.exports = app;

function main() {
  var http = require('http');

  // Configure the application.
  app.configure(function () {
    // ... ... ...
  });
  app.configure('production', function () {
    // ... ... ...
  });
  app.configure('development', function () {
    // ... ... ...
  });

  var server = http.createServer(app);

  // Load all routes.
  require('./routes')(app);

  // Listen on http port.
  server.listen(3000);
}

database.connect(function (err) {
  if (err) { 
    // ...
  }
  main();
});

маршруты/

каталог маршрутов имеет . Его цель-ввести своего рода магию для загрузки всех других файлов внутри . Вот реализация:

/**
 * This module loads dynamically all routes modules located in the routes/
 * directory.
 */
'use strict';
var fs = require('fs');
var path = require('path');

module.exports = function (app) {
  fs.readdirSync('./routes').forEach(function (file) {
    // Avoid to read this current file.
    if (file === path.basename(__filename)) { return; }

    // Load the route file.
    require('./' + file)(app);
  });
};

С помощью этого модуля создать новое определение маршрута и его реализацию очень просто. Например, hello.js:

function hello(req, res) {
  res.send('Hello world');
}

module.exports = function (app) {
  app.get('/api/hello_world', hello);
};

каждый модуль маршрута автономной.

Мне нравится использовать глобальные "приложение", а не экспортировать функцию и т. д.

Я думаю, что это отличный способ, чтобы сделать это. Не ограничиваясь выражением, но я видел довольно много узлов.проекты js на github делают то же самое. Они вынимают параметры конфигурации + меньшие модули (в некоторых случаях каждый URI) учитываются в отдельных файлах.

Я бы рекомендовал пройти экспресс-проекты на github, чтобы получить идею. IMO то, как вы делаете, правильно.

сейчас конец 2015 и после развивать мою структуру на 3 лет и в небольших и больших проектах. Вывод?

Не делайте один большой MVC, но отделите его в модулях

Так...

почему?

• обычно один работает на одном модуле (например, продукты), который вы можете изменить независимо.

• вы можете использовать модули

• вы можете проверить его отдельно

• вы можете заменить его отдельно

• Они имеют четкие (стабильные) интерфейсы

  -в крайнем случае, если было несколько разработчиков, работающих, разделение модулей помогает

на nodebootstrap проект имеет аналогичный подход к моей окончательной структуре. (github)

Как эта структура выглядит как?

1. малые, capsulated модули, каждый с отдельным MVC

2. каждый модуль есть пакет.в JSON

3. тестирование как часть структуры (в каждом модуле)

4. глобальная конфигурация, библиотеках и услуги

5. Интегрированный Докер, Кластер, навсегда!--3-->

Folderoverview (см. папку lib для модулей):

прошло довольно много времени с момента последнего ответа на этот вопрос, и Express также недавно выпустила версию 4, которая добавила несколько полезных вещей для организации структуры вашего приложения.

Ниже приведен длинный обновленный блог о лучших практиках по структурированию вашего Экспресс-приложения. http://www.terlici.com/2014/08/25/best-practices-express-structure.html

существует также репозиторий GitHub, применяющий рекомендации в статье. Это всегда дата с последней версией Express.
https://github.com/terlici/base-express

Я не думаю, что это хороший подход для добавления маршрутов в config. Лучшей структурой может быть что-то вроде этого:

application/
| - app.js
| - config.js
| - public/ (assets - js, css, images)
| - views/ (all your views files)
| - libraries/ (you can also call it modules/ or routes/)
    | - users.js
    | - products.js
    | - etc...

Так продукты.js и пользователи.js будет содержать все ваши маршруты, будет вся логика внутри.

Ну, я поставил свои маршруты как файл json, который я читал в начале, и в for-loop в приложении.js установил маршруты. Маршрут.json включает в себя представление, которое должно быть вызвано, и ключ для значений, которые будут отправлены в маршрут.
Это работает для многих простых случаев, но мне пришлось вручную создавать некоторые маршруты для особых случаев.

Это может быть интересно:

https://github.com/flatiron/nconf

иерархический узел.конфигурация js с файлами, переменными среды, аргументами командной строки и слиянием атомарных объектов.

Я написал сообщение именно об этом вопросе. Он в основном использует routeRegistrar, который перебирает файлы в папке /controllers вызова функции init. Функция init берет экспресс app переменной в качестве параметра, так что вы можете регистрировать свои маршруты так, как вы хотите.

var fs = require("fs");
var express = require("express");
var app = express();

var controllersFolderPath = __dirname + "/controllers/";
fs.readdirSync(controllersFolderPath).forEach(function(controllerName){
    if(controllerName.indexOf("Controller.js") !== -1){
        var controller = require(controllersFolderPath + controllerName);
        controller.init(app);
    }
});

app.listen(3000);

1) Ваша файловая система экспресс-проекта может быть, как:

/ ...
/lib
/node_modules
/public
/views
      app.js
      config.json
      package.json

app.Яш - вы можете взломать контейнер

2) основной файл модуля (lib/mymodule / index.в JS):

var express = require('express');    
var app = module.exports = express();
// and load module dependencies ...  

// this place to set module settings
app.set('view engine', 'jade');
app.set('views', __dirname + '/views');

// then do module staff    
app.get('/mymodule/route/',function(req,res){ res.send('module works!') });

3) подключить модуль в главном приложении.js

...
var mymodule = require('mymodule');
app.use(mymodule);

4) пример логики

lib/login
lib/db
lib/config
lib/users
lib/verify
lib/
   /api/ 
   ...
lib/
   /admin/
      /users/
      /settings/
      /groups/
...

• лучше всего для тестирования
• лучше всего для масштаба
• отдельный зависит от модуля
• группировка маршрута по функциональности (или модули)

tj говорит / показать на Vimeo интересная идея, как модульная экспресс-приложение - модульные веб-приложения с узлом.js и Express. Мощный и простой.

http://locomotivejs.org/ обеспечивает возможность структурировать приложение построено с узлом.js и Экспресс.

на сайте:

"Локомотив-это веб-фреймворк для узла.js. Локомотив поддерживает MVC шаблоны, маршруты RESTful и соглашение по конфигурации, в то время как интеграции с любой базой данных и шаблонизатор. Локомотив строит на Express, сохраняя мощность и простоту вы привыкли ожидать от Узел."

Я даю структуру папок стиля MVC, пожалуйста, найдите ниже .

мы использовали структуру папок ниже для наших больших и средних веб-приложений .

 myapp   
|
|
|____app
|      |____controllers
|      |    |____home.js
|      |
|      |____models
|      |     |___home.js
|      |
|      |____views
|           |___404.ejs
|           |___error.ejs
|           |___index.ejs
|           |___login.ejs
|           |___signup.ejs
|   
|
|_____config
|     |___auth.js
|     |___constants.js
|     |___database.js
|     |___passport.js
|     |___routes.js
|
|
|____lib
|    |___email.js
|
|____node_modules
|
|
|____public.js
|    |____css
|    |    |__style.css
|    |    
|    |____js
|    |    |__script.js
|    |
|    |____img
|    |    |__img.jpg
|    |
|    |
|    |____uploads
|         |__img.jpg
|      
|   
|
|_____app.js
|
|
|
|_____package.json

Я создал один модуль npm для создания структуры папок express MVC.

пожалуйста, найдите ниже https://www.npmjs.com/package/express-mvc-generator

просто простые шаги для создания и использования этих модулей .

i) установить модуль npm install express-mvc-generator -g

ii) проверьте параметры express -h

iii) создание экспресс-структуры mvc express myapp

iv) установить зависимости:npm install:

v) откройте конфигурацию/базу данных.js, пожалуйста, настройте свой Mongo db.

vi) запустите приложение node app или nodemon app

vii) Проверьте URL http://localhost:8042/signup или http://yourip:8042/signup

недавно я принял модули в качестве независимых мини-приложений.

|-- src
  |--module1
  |--module2
     |--www
       |--img
       |--js
       |--css
     |--#.js
     |--index.ejs
  |--module3
  |--www
     |--bower_components
     |--img
     |--js
     |--css
  |--#.js
  |--header.ejs
  |--index.ejs
  |--footer.ejs

Теперь для любой маршрутизации модуля (#.js), views (*.ejs), js, css и активы находятся рядом друг с другом. маршрутизация подмодулей настраивается в Родительском #.js с двумя дополнительными строками

router.use('/module2', opt_middleware_check, require('./module2/#'));
router.use(express.static(path.join(__dirname, 'www')));

таким образом, даже subsubmodules возможны.

не забудьте установить вид в каталог src

app.set('views', path.join(__dirname, 'src'));

так выглядит большая часть моей структуры каталогов express project.

я обычно делаю express dirname чтобы инициализировать проект, простите мою лень, но он очень гибкий и расширяемый. PS-вам нужно получить express-generator для этого (для тех, кто ищет его sudo npm install -g express-generator, sudo, потому что вы устанавливаете его глобально)

|-- bin
    |-- www //what we start with "forever"
|-- bower_components
|-- models
    |-- database.js
    |-- model1.js //not this exact name ofcourse.
    |-- .
|-- node_modules
|-- public
    |-- images
    |-- javascripts
        |-- controllers
        |-- directives
        |-- services
        |-- app.js
        |-- init.js //contains config and used for initializing everything, I work with angular a lot.
    |-- stylesheets
|-- routes
    |-- some
    |-- hierarchy
    .
    .
|-- views
    |-- partials
    |-- content
|-- .env
|-- .env.template
|-- app.js
|-- README.md

вам должно быть интересно, почему .файлы env? Потому что они работают! Я использую dotenv модуль в моих проектах (много в последнее время) и это работает! Поп в эти 2 утверждения в app.js или www

var dotenv = require('dotenv');
dotenv.config({path: path.join(__dirname + "/.env")});

и еще одна строка, чтобы быстро установить /bower_components для обслуживания статического контента в рамках ресурса /ext

app.use('/ext', express.static(path.join(__dirname, 'bower_components')));

это, вероятно, может быть подходит для людей, которые хотят использовать Express и Angular вместе, или просто выразить без этого javascripts иерархия, конечно.

моя структура выражает 4. https://github.com/odirleiborgert/borgert-express-boilerplate

пакетов

View engine: twig
Security: helmet
Flash: express-flash
Session: express-session
Encrypt: bcryptjs
Modules: express-load
Database: MongoDB
    ORM: Mongoose
    Mongoose Paginate
    Mongoose Validator
Logs: winston + winston-daily-rotate-file
Nodemon
CSS: stylus
Eslint + Husky

структура

|-- app
    |-- controllers
    |-- helpers
    |-- middlewares
    |-- models
    |-- routes
    |-- services
|-- bin
|-- logs
|-- node_modules
|-- public
    |-- components
    |-- images
    |-- javascripts
    |-- stylesheets
|-- views
|-- .env
|-- .env-example
|-- app.js
|-- README.md