django-urls

Sistema de urls semelhante ao Django

Através do método 'route', você informa ao Django-Urls que ele será responsável por gerenciar as rotas do seu aplicativo. Este método, route, precisa de uma instãncia do Express, comumente uma variavel 'app'. O segundo parametro é uma lista de urls inicial (como raiz de sua aplicação) e, por último, um objeto de configuração.

#Django-Urls for nodejs

##Instalação

Instalável através do Node Pakage Control (npm)

$ npm install django-urls

##Importar o modulo em seu "app"

var djangourls = require("django-urls");

##Configuração básica e opcional

djangourls.configure({
    root: path.join(__dirname, "src"), // o nome da pasta base onde serão procuradas as urls 
    debug: true, // mostra mensagens sobre cada passo importante do modulo 
    views: "views", // nome padrão para script com views¹ 
    urls: "urls", // nome padrão para scripts de urls² 
});

¹ javascript contendo as funcões de respostas à página

² javascript contendo uma lista de urls (opcional)

##Exemplo de uso

Quando utilizada com get, post ou all, a sintaxe para o comando é o seguinte:

metodo("rota", "dir.fn", "dir.middlewares")
  • rota: O caminho que deve ser mapeado (/auth por exemplo)
  • dir.fn: O caminho para a pasta onde deve estar ao minimo o arquivo de views.js mais o nome da função que deve processar essa rota (fn) separados por pontos
  • [opcional] dir.middlewares: lista de middlewares, seguindo a mesmo padrão anterior, mas sem a função no final, o modulo será interpretado como função (module.exports = function(req, res, next){})

Exemplo:

Um exemplo mais completo pode ser encontrado neste repositório

##Terminal

desativado !

Você pode gerar os arquivos de urls.js e arquivos de apps diretamente pelo terminal¹ rodando o seguinte comando:

// para iniciar em ./src 
$ djangourls start
 
// para iniciar em ./mysourcepath 
$ djangourls start mysourcepath
 
// para iniciar a app auth no diretório atual 
$ djangourls startapp auth

¹ necessita de instalação global: npm install django-urls -g

##Change log

2014-01-14

  • Versão 3 enviada ao npm

2013-10-23

  • creditos de revisão para Julie
  • pt-BR (ideia errado)
  • fix bug no middleware

2013-10-22

  • atualizado README.md

2013-10-13

  • adicionado django-urls.min e removido o Makefile via npmignore

##Github

Não deixe de visitar a pagina do projeto no GitHub, qualquer duvida basta entrar em contato

##Agradecimentos

Muito obrigado a Julie por me ajudar na correção deste README.md