Atenção: Essa é a versão beta feita com DocPad (NodeJS), se você está utilizando a versão alpha em Jekyll (Ruby), por favor visite a branch jekyll ou então baixe o repositório via tag 0.1.0-alpha.zip.
Uma iniciativa da BrazilJS Foundation para ajudar aqueles que querem organizar conferências/eventos e não tem muito tempo para criar o site disso.
Nós usamos o DocPad, um static generator em NodeJS, para criar esse modelo extremamente simples de customizar. Além disso, a hospedagem é gratuita via Github Pages e você ainda pode usar seu próprio domínio (mais informações sobre isso em Deploy).
Por padrão, definimos as seguintes seções:
- About - Para que você possa descrever o objetivo do seu evento.
- Location - Para que você possa exibir a localização do seu evento através do Google Maps.
- Speakers - Para que você possa listar informações sobre os palestrantes.
- Schedule - Para que você possa mostrar a agenda do evento.
- Sponsors - Para que você possa fazer propaganda dos seus patrocinadores.
- Partners - Para que você possa fazer propaganda dos seus apoiadores.
OBS 1: Não há integração com nenhum sistema de inscrição e/ou pagamento. Por conta disso, indicamos o Eventick.
OBS 2: Por enquanto ainda não conseguimos desenvolver uma solução altamente automatizada e customizável para formulários de contato. Por conta disso, indicamos o Wufoo.
A estrutura básica do projeto se dá na seguinte forma:
. |-- out/ |-- src/ | |-- documents | |-- files | |-- layouts | |-- partials |-- CNAME |-- docpad.cson |-- package.json `-- publish.sh
É onde os arquivos gerados são armazenados, uma vez que o DocPad tenha sido rodado. Porém, esse diretório se torna desnecessário no versionamento, por isso está ignorado (.gitignore).
Contém o arquivo responsável por importar todas as seções da aplicação.
Possui as imagens, arquivos CSS e JS.
Contém o template padrão da aplicação.
São blocos de código utilizados para gerar a página principal do site (index.html).
Indica o domínio personalizado que deve ser usado (mais informações sobre como usar seu domínio próprio em Deploy).
Armazena de forma fácil a maior parte das configurações da aplicação.
Lista as dependências de módulos do NodeJS.
Shell Script responsável pela publicação do site via Github Pages.
-
Abra o terminal e instale o DocPad através do comando:
sudo npm install -fg [email protected] -
Agora clone o projeto:
git clone [email protected]:braziljs/conf-boilerplate.git -
Depois vá para pasta do projeto:
cd conf-boilerplate -
Instale as dependências:
npm install . -
E finalmente rode:
docpad run
Agora você irá ver o site rodando em localhost:9778 :D
O projeto já vem com um template visual pronto, use-o à vontade, mas nós recomendamos que você crie seu próprio, a fim de colocar sua própria cara no evento.
De qualquer forma, nós preparamos algo altamente customizável para você, portanto para maioria das alterações do projeto basta ir até o docpad.cson e alterar o valor das variáveis.
Quer alterar o nome, data, endereço, cidade ou preço do evento? É só mudar.
conf:
name: "Conference name"
description: "Conference description"
date: "November 15"
price: "$100"
address: "Boulevard Kukulcan, 30, México"
venue: "Coco Bongo"
city: "Cancún"
Quer mudar a imagem de capa, código do Google Analytics ou o favicon? Vá em frente!
site:
url: "http://confboilerplate.com"
favicon: "http://braziljs.org/favicon.ico"
googleanalytics: "UA-33656081-1"
images:
cover: "http://f.cl.ly/items/2X28422q1e3w0C2U1P3H/866591_24254643.jpg"
facebook: "http://braziljs.org/img/fb-share.jpg"
Ainda não definiu a programação completa do evento? Não tem problema, basta alterar a variável schedule para false.
Ainda não sabe quem irá palestrar? Tudo bem, basta alterar a variável speakers para false.
E por aí vai.
sections:
about: true
location: true
speakers: true
schedule: true
sponsors: true
partners: true
contact: false
Para incluir/alterar/excluir um palestrante também é igualmente simples, basta recorrer ao schedule.
schedule: [
name: "Chuck Norris"
photo: "http://f.cl.ly/items/2A3p1N0C3c0n3N3R1w2B/speaker.jpg"
bio: "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo"
company: "Delta Command"
twitter: "littlechuck"
presentation:
title: "How to kill a elephant with one finger"
description: "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo"
time: "13h00"
]
Quer listar mais algum atributo do palestrante que não está ali, tudo bem é só adicionar no docpad.cson e depois exibí-lo com <%= speaker.seuNovoAtributo %> no speakers.html.eco.
Para alterar os horários de check-in, almoço e coffee-break, é só recorrer as variáveis de schedule.
schedule: [
name: "Check-in / Breakfast"
time: "9h00"
]
Mas se você quiser adicionar mais um coffee-break ou qualquer outro tipo de item na agenda do evento, é só acrescentar mais um item nessa lista.
Para adicionar qualquer patrocinador ou apoio no evento, é só recorrer as variáveis sponsors e partners.
partners: [
name: "BrazilJS"
logo: "http://f.cl.ly/items/2N3i2W0X2f3c2g2Z2N0f/Untitled-1.png"
url: "http://braziljs.org"
]
Nós não gostamos de centralizar o poder de deploy em uma pessoa, portanto utilizaremos o recurso de Github Pages que ainda é gratuito.
- Rode
sh publish.shna raíz do projeto.
Espere alguns minutos até que o Github lhe envie um e-mail avisando que tudo ocorreu bem. Depois é só acessar: http://seuUsuario.github.com/seuFork
OBS: Lembre-se de remover o arquivo CNAME, caso você queira utilizar a URL pré-definida pelo Github.
Caso você não queira utilizar o domínio do Github, é possível usar seu próprio com alguns passos.
- Altere o arquivo
CNAMEna raíz do seu projeto e preencha com o nome do seu domínio:seuevento.com. Veja o exemplo. - Altere o DNS do seu domínio seguindo as instruções do Github.
Se você prefere utilizar seu próprio servidor para hospedar o site:
- Rode
docpad generatena raíz do projeto.
Esse comando irá gerar uma pasta out contendo apenas arquivos estáticos, depois é só fazer o upload do conteúdo dessa pasta para sua hospedagem.
Confira os eventos que usaram esse projeto como pontapé inicial:
Nós somos um grupo de desenvolvedores que passaram por muitas dificuldades organizando conferências pelo Brasil e agora queremos ajudar outras pessoas nesse árduo trabalho.
Líder do Projeto: Zeno Rocha
Agradecimento especial a todos os membros da comunidade pelos feedbacks e contribuições.